Skip to content

Commit 1799822

Browse files
committed
adding HTML documentation for publication
1 parent fd3597b commit 1799822

28 files changed

Lines changed: 392 additions & 78 deletions

CHANGELOG.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,16 @@
11

2+
## releasing 1.3.0 (2024-07-22)
3+
### Overview
4+
This version added two universal runtime parameters that make some aspects of the runtime environment are recorded in the views' metadata.
5+
6+
7+
### Additions
8+
- `hwFetch` universal parameter will record CPU architecture and CUDA devices in `view.metadata.appRunningHardware`
9+
- `runningTime` universal parameter will record app's running time in `view.metadata.appRunningTime`
10+
- See https://github.com/clamsproject/clams-python/issues/236 for rationale behind
11+
12+
13+
214
## releasing 1.2.6 (2024-07-15)
315
### Overview
416
Patch release to update mmif SDK version, and minor improvements

docs/.doctrees/appmetadata.doctree

90 Bytes
Binary file not shown.
790 Bytes
Binary file not shown.
190 KB
Binary file not shown.

docs/.doctrees/environment.pickle

282 KB
Binary file not shown.
1.04 KB
Binary file not shown.

docs/_sources/appmetadata.rst.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ input specification can be as simple as the following:
9191
# and more app metadata fields,
9292
}
9393
94-
In the above example, the developer is declaring the app is expecting ``Token``annotation objects, with a ``posTagSet``
94+
In the above example, the developer is declaring the app is expecting ``Token`` annotation objects, with a ``posTagSet``
9595
property of which value is the URL of the Penn Treebank POS tag set, *verbatim*, in the input MMIF, and all other
9696
existing annotation types in the input MMIF will be ignored during processing. There are some *grammar* of how this
9797
``input`` list can be written.

docs/_sources/autodoc/clams.appmetadata.rst.txt

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,15 @@ Module contents
66

77
.. autoclass:: clams.appmetadata.AppMetadata
88
:members:
9+
10+
.. autoclass:: clams.appmetadata.Input
11+
:members:
12+
:inherited-members:
13+
14+
.. autoclass:: clams.appmetadata.Output
15+
:members:
16+
:inherited-members:
17+
18+
.. autoclass:: clams.appmetadata.RuntimeParameter
19+
:members:
20+
:inherited-members:

docs/appdirectory.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
clams-python
3838
</a>
3939
<div class="version">
40-
1.2.6
40+
1.3.0
4141
</div>
4242
<div role="search">
4343
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">

docs/appmetadata.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
clams-python
3838
</a>
3939
<div class="version">
40-
1.2.6
40+
1.3.0
4141
</div>
4242
<div role="search">
4343
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
@@ -182,7 +182,7 @@ <h5>Simple case - using types as defined in the vocabularies<a class="headerlink
182182
<span class="p">}</span>
183183
</pre></div>
184184
</div>
185-
<p>In the above example, the developer is declaring the app is expecting <code class="docutils literal notranslate"><span class="pre">Token``annotation</span> <span class="pre">objects,</span> <span class="pre">with</span> <span class="pre">a</span> <span class="pre">``posTagSet</span></code>
185+
<p>In the above example, the developer is declaring the app is expecting <code class="docutils literal notranslate"><span class="pre">Token</span></code> annotation objects, with a <code class="docutils literal notranslate"><span class="pre">posTagSet</span></code>
186186
property of which value is the URL of the Penn Treebank POS tag set, <em>verbatim</em>, in the input MMIF, and all other
187187
existing annotation types in the input MMIF will be ignored during processing. There are some <em>grammar</em> of how this
188188
<code class="docutils literal notranslate"><span class="pre">input</span></code> list can be written.</p>

0 commit comments

Comments
 (0)