Skip to content

Commit cee2505

Browse files
keighrimkeighrim
authored
Merge pull request #167 from clamsproject/register/0-spacy-wrapper.v2.0
App Submitted - spacy-wrapper.v2.0
2 parents 5c9f961 + 50f8fff commit cee2505

File tree

5 files changed

+166
-19
lines changed

5 files changed

+166
-19
lines changed

‎docs/_apps/spacy-wrapper/v2.0/index.md

+81
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
---
2+
layout: posts
3+
classes: wide
4+
title: "CLAMS wrapper for spaCy NLP (v2.0)"
5+
date: 2024-07-16T16:49:38+00:00
6+
---
7+
## About this version
8+
9+
- Submitter: [keighrim](https://github.com/keighrim)
10+
- Submission Time: 2024-07-16T16:49:38+00:00
11+
- Prebuilt Container Image: [ghcr.io/clamsproject/app-spacy-wrapper:v2.0](https://github.com/clamsproject/app-spacy-wrapper/pkgs/container/app-spacy-wrapper/v2.0)
12+
- Release Notes
13+
14+
(no notes provided by the developer)
15+
16+
## About this app (See raw [metadata.json](metadata.json))
17+
18+
**Apply spaCy NLP to all text documents in a MMIF file.**
19+
20+
- App ID: [http://apps.clams.ai/spacy-wrapper/v2.0](http://apps.clams.ai/spacy-wrapper/v2.0)
21+
- App License: Apache 2.0
22+
- Source Repository: [https://github.com/clamsproject/app-spacy-wrapper](https://github.com/clamsproject/app-spacy-wrapper) ([source tree of the submitted version](https://github.com/clamsproject/app-spacy-wrapper/tree/v2.0))
23+
- Analyzer Version: 3.6
24+
- Analyzer License: MIT
25+
26+
27+
#### Inputs
28+
(**Note**: "*" as a property value means that the property is required but can be any value.)
29+
30+
- [http://mmif.clams.ai/vocabulary/TextDocument/v1](http://mmif.clams.ai/vocabulary/TextDocument/v1) (required)
31+
(of any properties)
32+
33+
- [http://vocab.lappsgrid.org/Token](http://vocab.lappsgrid.org/Token)
34+
(of any properties)
35+
36+
37+
38+
#### Configurable Parameters
39+
(**Note**: _Multivalued_ means the parameter can have one or more values.)
40+
41+
- `pretokenized`: optional, defaults to `false`
42+
43+
- Type: boolean
44+
- Multivalued: False
45+
- Choices: **_`false`_**, `true`
46+
47+
48+
> Boolean parameter to set the app to use existing tokenization, if available, for text documents for NLP processing. Useful to process ASR documents, for example.
49+
- `pretty`: optional, defaults to `false`
50+
51+
- Type: boolean
52+
- Multivalued: False
53+
- Choices: **_`false`_**, `true`
54+
55+
56+
> The JSON body of the HTTP response will be re-formatted with 2-space indentation
57+
58+
59+
#### Outputs
60+
(**Note**: "*" as a property value means that the property is required but can be any value.)
61+
62+
(**Note**: Not all output annotations are always generated.)
63+
64+
- [http://vocab.lappsgrid.org/Token](http://vocab.lappsgrid.org/Token)
65+
(of any properties)
66+
67+
- [http://vocab.lappsgrid.org/Token#pos](http://vocab.lappsgrid.org/Token#pos)
68+
(of any properties)
69+
70+
- [http://vocab.lappsgrid.org/Token#lemma](http://vocab.lappsgrid.org/Token#lemma)
71+
(of any properties)
72+
73+
- [http://vocab.lappsgrid.org/NounChunk](http://vocab.lappsgrid.org/NounChunk)
74+
(of any properties)
75+
76+
- [http://vocab.lappsgrid.org/Sentence](http://vocab.lappsgrid.org/Sentence)
77+
(of any properties)
78+
79+
- [http://vocab.lappsgrid.org/NamedEntity](http://vocab.lappsgrid.org/NamedEntity)
80+
(of any properties)
81+

‎docs/_apps/spacy-wrapper/v2.0/metadata.json

+57
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
{
2+
"name": "CLAMS wrapper for spaCy NLP",
3+
"description": "Apply spaCy NLP to all text documents in a MMIF file.",
4+
"app_version": "v2.0",
5+
"mmif_version": "1.0.5",
6+
"analyzer_version": "3.6",
7+
"app_license": "Apache 2.0",
8+
"analyzer_license": "MIT",
9+
"identifier": "http://apps.clams.ai/spacy-wrapper/v2.0",
10+
"url": "https://github.com/clamsproject/app-spacy-wrapper",
11+
"input": [
12+
{
13+
"@type": "http://mmif.clams.ai/vocabulary/TextDocument/v1",
14+
"required": true
15+
},
16+
{
17+
"@type": "http://vocab.lappsgrid.org/Token",
18+
"required": false
19+
}
20+
],
21+
"output": [
22+
{
23+
"@type": "http://vocab.lappsgrid.org/Token"
24+
},
25+
{
26+
"@type": "http://vocab.lappsgrid.org/Token#pos"
27+
},
28+
{
29+
"@type": "http://vocab.lappsgrid.org/Token#lemma"
30+
},
31+
{
32+
"@type": "http://vocab.lappsgrid.org/NounChunk"
33+
},
34+
{
35+
"@type": "http://vocab.lappsgrid.org/Sentence"
36+
},
37+
{
38+
"@type": "http://vocab.lappsgrid.org/NamedEntity"
39+
}
40+
],
41+
"parameters": [
42+
{
43+
"name": "pretokenized",
44+
"description": "Boolean parameter to set the app to use existing tokenization, if available, for text documents for NLP processing. Useful to process ASR documents, for example.",
45+
"type": "boolean",
46+
"default": false,
47+
"multivalued": false
48+
},
49+
{
50+
"name": "pretty",
51+
"description": "The JSON body of the HTTP response will be re-formatted with 2-space indentation",
52+
"type": "boolean",
53+
"default": false,
54+
"multivalued": false
55+
}
56+
]
57+
}

‎docs/_apps/spacy-wrapper/v2.0/submission.json

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"time": "2024-07-16T16:49:38+00:00",
3+
"submitter": "keighrim",
4+
"image": "ghcr.io/clamsproject/app-spacy-wrapper:v2.0"
5+
}

‎docs/_data/app-index.json

+22-18
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,26 @@
11
{
2+
"http://apps.clams.ai/spacy-wrapper": {
3+
"description": "Apply spaCy NLP to all text documents in a MMIF file.",
4+
"latest_update": "2024-07-16T16:49:38+00:00",
5+
"versions": [
6+
[
7+
"v2.0",
8+
"keighrim"
9+
],
10+
[
11+
"v1.2",
12+
"marcverhagen"
13+
],
14+
[
15+
"v1.1",
16+
"keighrim"
17+
],
18+
[
19+
"v1",
20+
"keighrim"
21+
]
22+
]
23+
},
224
"http://apps.clams.ai/text-slicer": {
325
"description": "Slice text snippets from a provided text document given time frames",
426
"latest_update": "2024-07-02T01:30:06+00:00",
@@ -141,24 +163,6 @@
141163
]
142164
]
143165
},
144-
"http://apps.clams.ai/spacy-wrapper": {
145-
"description": "Apply spaCy NLP to all text documents in a MMIF file.",
146-
"latest_update": "2024-06-11T12:30:19+00:00",
147-
"versions": [
148-
[
149-
"v1.2",
150-
"marcverhagen"
151-
],
152-
[
153-
"v1.1",
154-
"keighrim"
155-
],
156-
[
157-
"v1",
158-
"keighrim"
159-
]
160-
]
161-
},
162166
"http://apps.clams.ai/llava-captioner": {
163167
"description": "Applies llava to video frames.",
164168
"latest_update": "2024-05-23T19:38:32+00:00",

‎docs/_data/apps.json

+1-1
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)