Skip to content

Commit

Permalink
regenerated 1.1.0 html files
Browse files Browse the repository at this point in the history
  • Loading branch information
keighrim committed Jan 30, 2024
1 parent 35d919a commit fa34a55
Show file tree
Hide file tree
Showing 21 changed files with 24 additions and 23 deletions.
7 changes: 4 additions & 3 deletions docs/1.1.0/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,17 +155,18 @@ This property contains information about the annotations in a view. Here is an e
"document": "m1"
}
},
"parameters": {}
"parameters": {"threshold": "0.5", "not-defined-parameter": "some-value"},
"refinedParameters": {"threshold": 0.5}
}
```

The `timestamp` key stores when the view was created by the application. This is using the ISO 8601 format where the T separates the date from the time of the day. The timestamp can also be used to order views, which is significant because by default arrays in JSON-LD are not ordered.

The `app` key contains an identifier that specifies what application created the view. The identifier must be a URL form, and HTTP webpage pointed by the URL should contain all app metadata information relevant for the application: description, configuration, input/output specifications and a more complete description of what output is created. The app identifier always includes a version number for the app. The metadata should also contain a link to the public code repository for the app (and that repository will actually maintain all the information in the URL).

The `parameters` is a dictionary of parameters and their values in *string*, if any, that were raw data handed to the app at the runtime when it was called. Note that CLAMS apps are developed to run as HTTP servers, expecting parameters to be passed as URL query strings. Hence, the values in the `parameters` dictionary are always strings or simple lists of strings.
The `parameters` is a dictionary of runtime parameters and their *string* values, if any. The primary purpose of this dictionary is to record the parameters "as-is" for reproducibility and accountability. Note that CLAMS apps are developed to run as HTTP servers, expecting parameters to be passed as URL query strings. Hence, the values in the `parameters` dictionary are always strings or simple lists of strings.

The `refinedParameters` is a dictionary of parameters and their values, after some automatic refinement of the runtime parameters. Automatic refinement can include:
The `refinedParameters` is an dictionary of parameters and their values, after some automatic refinement of the runtime parameters. Automatic refinement can include:

1. Converting data types according to the parameter specification.
2. Adding default values for parameters that were not specified.
Expand Down
2 changes: 1 addition & 1 deletion docs/1.1.0/schema/mmif.json
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@
"$ref": "#/definitions/strStrMap"
},
"refinedParameters": {
"$ref": "#/definitions/strStrMap"
"type": "object"
}
},
"oneOf": [
Expand Down
2 changes: 1 addition & 1 deletion docs/1.1.0/vocabulary/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -424,7 +424,7 @@ <h2>
</div>
</div>
<div id="footer">
Page generated on 2024-01-02 at 16:35:07
Page generated on 2024-01-30 at 08:35:43
</div>
</body>
</html>
2 changes: 1 addition & 1 deletion docs/vocabulary/Alignment/v1/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -216,7 +216,7 @@ <h2>
</div>
</div>
<div id="footer">
Page generated on 2024-01-02 at 16:35:07
Page generated on 2024-01-30 at 08:35:43
</div>
</body>
</html>
2 changes: 1 addition & 1 deletion docs/vocabulary/Annotation/v2/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ <h2>
</div>
</div>
<div id="footer">
Page generated on 2024-01-02 at 16:35:07
Page generated on 2024-01-30 at 08:35:43
</div>
</body>
</html>
2 changes: 1 addition & 1 deletion docs/vocabulary/AudioDocument/v1/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ <h2>
</div>
</div>
<div id="footer">
Page generated on 2024-01-02 at 16:35:07
Page generated on 2024-01-30 at 08:35:43
</div>
</body>
</html>
2 changes: 1 addition & 1 deletion docs/vocabulary/BoundingBox/v1/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -304,7 +304,7 @@ <h2>
</div>
</div>
<div id="footer">
Page generated on 2024-01-02 at 16:35:07
Page generated on 2024-01-30 at 08:35:43
</div>
</body>
</html>
2 changes: 1 addition & 1 deletion docs/vocabulary/Chapter/v1/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -345,7 +345,7 @@ <h2>
</div>
</div>
<div id="footer">
Page generated on 2024-01-02 at 16:35:07
Page generated on 2024-01-30 at 08:35:43
</div>
</body>
</html>
2 changes: 1 addition & 1 deletion docs/vocabulary/Document/v1/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ <h2>
</div>
</div>
<div id="footer">
Page generated on 2024-01-02 at 16:35:07
Page generated on 2024-01-30 at 08:35:43
</div>
</body>
</html>
2 changes: 1 addition & 1 deletion docs/vocabulary/ImageDocument/v1/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ <h2>
</div>
</div>
<div id="footer">
Page generated on 2024-01-02 at 16:35:07
Page generated on 2024-01-30 at 08:35:43
</div>
</body>
</html>
2 changes: 1 addition & 1 deletion docs/vocabulary/Interval/v1/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -279,7 +279,7 @@ <h2>
</div>
</div>
<div id="footer">
Page generated on 2024-01-02 at 16:35:07
Page generated on 2024-01-30 at 08:35:43
</div>
</body>
</html>
2 changes: 1 addition & 1 deletion docs/vocabulary/Polygon/v1/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -271,7 +271,7 @@ <h2>
</div>
</div>
<div id="footer">
Page generated on 2024-01-02 at 16:35:07
Page generated on 2024-01-30 at 08:35:43
</div>
</body>
</html>
2 changes: 1 addition & 1 deletion docs/vocabulary/Region/v1/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -224,7 +224,7 @@ <h2>
</div>
</div>
<div id="footer">
Page generated on 2024-01-02 at 16:35:07
Page generated on 2024-01-30 at 08:35:43
</div>
</body>
</html>
2 changes: 1 addition & 1 deletion docs/vocabulary/Relation/v1/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@ <h2>
</div>
</div>
<div id="footer">
Page generated on 2024-01-02 at 16:35:07
Page generated on 2024-01-30 at 08:35:43
</div>
</body>
</html>
2 changes: 1 addition & 1 deletion docs/vocabulary/Span/v2/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -260,7 +260,7 @@ <h2>
</div>
</div>
<div id="footer">
Page generated on 2024-01-02 at 16:35:07
Page generated on 2024-01-30 at 08:35:43
</div>
</body>
</html>
2 changes: 1 addition & 1 deletion docs/vocabulary/TextDocument/v1/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,7 @@ <h2>
</div>
</div>
<div id="footer">
Page generated on 2024-01-02 at 16:35:07
Page generated on 2024-01-30 at 08:35:43
</div>
</body>
</html>
2 changes: 1 addition & 1 deletion docs/vocabulary/Thing/v1/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ <h1>
</div>
</div>
<div id="footer">
Page generated on 2024-01-02 at 16:35:07
Page generated on 2024-01-30 at 08:35:43
</div>
</body>
</html>
2 changes: 1 addition & 1 deletion docs/vocabulary/TimeFrame/v2/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -274,7 +274,7 @@ <h2>
</div>
</div>
<div id="footer">
Page generated on 2024-01-02 at 16:35:07
Page generated on 2024-01-30 at 08:35:43
</div>
</body>
</html>
2 changes: 1 addition & 1 deletion docs/vocabulary/TimePoint/v1/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -260,7 +260,7 @@ <h2>
</div>
</div>
<div id="footer">
Page generated on 2024-01-02 at 16:35:07
Page generated on 2024-01-30 at 08:35:43
</div>
</body>
</html>
2 changes: 1 addition & 1 deletion docs/vocabulary/VideoDocument/v1/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ <h2>
</div>
</div>
<div id="footer">
Page generated on 2024-01-02 at 16:35:07
Page generated on 2024-01-30 at 08:35:43
</div>
</body>
</html>
2 changes: 1 addition & 1 deletion docs/vocabulary/VideoObject/v1/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -260,7 +260,7 @@ <h2>
</div>
</div>
<div id="footer">
Page generated on 2024-01-02 at 16:35:07
Page generated on 2024-01-30 at 08:35:43
</div>
</body>
</html>

0 comments on commit fa34a55

Please sign in to comment.