Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

App Submitted - spacy-wrapper.v1.2 #154

Merged
merged 1 commit into from
Jun 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
85 changes: 85 additions & 0 deletions docs/_apps/spacy-wrapper/v1.2/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
---
layout: posts
classes: wide
title: "CLAMS wrapper for spaCy NLP (v1.2)"
date: 2024-06-11T12:30:19+00:00
---
## About this version

- Submitter: [marcverhagen](https://github.com/marcverhagen)
- Submission Time: 2024-06-11T12:30:19+00:00
- Prebuilt Container Image: [ghcr.io/clamsproject/app-spacy-wrapper:v1.2](https://github.com/clamsproject/app-spacy-wrapper/pkgs/container/app-spacy-wrapper/v1.2)
- Release Notes

> Bumping Python SDK version, bug fixes and documentation updates
> - Updated to clams-python 1.2.2
> - Fixed token length (issue #30)
> - Fixed problems with the pretokenized parameter (issue #32)
> - Various documentation fixes.

## About this app (See raw [metadata.json](metadata.json))

**Apply spaCy NLP to all text documents in a MMIF file.**

- App ID: [http://apps.clams.ai/spacy-wrapper/v1.2](http://apps.clams.ai/spacy-wrapper/v1.2)
- App License: Apache 2.0
- 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/v1.2))
- Analyzer Version: 3.6
- Analyzer License: MIT


#### Inputs
(**Note**: "*" as a property value means that the property is required but can be any value.)

- [http://mmif.clams.ai/vocabulary/TextDocument/v1](http://mmif.clams.ai/vocabulary/TextDocument/v1) (required)
(of any properties)

- [http://vocab.lappsgrid.org/Token](http://vocab.lappsgrid.org/Token)
(of any properties)



#### Configurable Parameters
(**Note**: _Multivalued_ means the parameter can have one or more values.)

- `pretokenized`: optional, defaults to `false`

- Type: boolean
- Multivalued: False
- Choices: **_`false`_**, `true`


> 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.
- `pretty`: optional, defaults to `false`

- Type: boolean
- Multivalued: False
- Choices: **_`false`_**, `true`


> The JSON body of the HTTP response will be re-formatted with 2-space indentation


#### Outputs
(**Note**: "*" as a property value means that the property is required but can be any value.)

(**Note**: Not all output annotations are always generated.)

- [http://vocab.lappsgrid.org/Token](http://vocab.lappsgrid.org/Token)
(of any properties)

- [http://vocab.lappsgrid.org/Token#pos](http://vocab.lappsgrid.org/Token#pos)
(of any properties)

- [http://vocab.lappsgrid.org/Token#lemma](http://vocab.lappsgrid.org/Token#lemma)
(of any properties)

- [http://vocab.lappsgrid.org/NounChunk](http://vocab.lappsgrid.org/NounChunk)
(of any properties)

- [http://vocab.lappsgrid.org/Sentence](http://vocab.lappsgrid.org/Sentence)
(of any properties)

- [http://vocab.lappsgrid.org/NamedEntity](http://vocab.lappsgrid.org/NamedEntity)
(of any properties)

57 changes: 57 additions & 0 deletions docs/_apps/spacy-wrapper/v1.2/metadata.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
{
"name": "CLAMS wrapper for spaCy NLP",
"description": "Apply spaCy NLP to all text documents in a MMIF file.",
"app_version": "v1.2",
"mmif_version": "1.0.4",
"analyzer_version": "3.6",
"app_license": "Apache 2.0",
"analyzer_license": "MIT",
"identifier": "http://apps.clams.ai/spacy-wrapper/v1.2",
"url": "https://github.com/clamsproject/app-spacy-wrapper",
"input": [
{
"@type": "http://mmif.clams.ai/vocabulary/TextDocument/v1",
"required": true
},
{
"@type": "http://vocab.lappsgrid.org/Token",
"required": false
}
],
"output": [
{
"@type": "http://vocab.lappsgrid.org/Token"
},
{
"@type": "http://vocab.lappsgrid.org/Token#pos"
},
{
"@type": "http://vocab.lappsgrid.org/Token#lemma"
},
{
"@type": "http://vocab.lappsgrid.org/NounChunk"
},
{
"@type": "http://vocab.lappsgrid.org/Sentence"
},
{
"@type": "http://vocab.lappsgrid.org/NamedEntity"
}
],
"parameters": [
{
"name": "pretokenized",
"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.",
"type": "boolean",
"default": false,
"multivalued": false
},
{
"name": "pretty",
"description": "The JSON body of the HTTP response will be re-formatted with 2-space indentation",
"type": "boolean",
"default": false,
"multivalued": false
}
]
}
6 changes: 6 additions & 0 deletions docs/_apps/spacy-wrapper/v1.2/submission.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"time": "2024-06-11T12:30:19+00:00",
"submitter": "marcverhagen",
"image": "ghcr.io/clamsproject/app-spacy-wrapper:v1.2",
"releasenotes": "Bumping Python SDK version, bug fixes and documentation updates\n\n- Updated to clams-python 1.2.2\n- Fixed token length (issue #30)\n- Fixed problems with the pretokenized parameter (issue #32)\n- Various documentation fixes.\n\n"
}
32 changes: 18 additions & 14 deletions docs/_data/app-index.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,22 @@
{
"http://apps.clams.ai/spacy-wrapper": {
"description": "Apply spaCy NLP to all text documents in a MMIF file.",
"latest_update": "2024-06-11T12:30:19+00:00",
"versions": [
[
"v1.2",
"marcverhagen"
],
[
"v1.1",
"keighrim"
],
[
"v1",
"keighrim"
]
]
},
"http://apps.clams.ai/llava-captioner": {
"description": "Applies llava to video frames.",
"latest_update": "2024-05-23T19:38:32+00:00",
Expand Down Expand Up @@ -315,20 +333,6 @@
]
]
},
"http://apps.clams.ai/spacy-wrapper": {
"description": "Apply spaCy NLP to all text documents in a MMIF file.",
"latest_update": "2023-07-24T17:39:56+00:00",
"versions": [
[
"v1.1",
"keighrim"
],
[
"v1",
"keighrim"
]
]
},
"http://apps.clams.ai/brandeis-acs-wrapper": {
"description": "Brandeis Acoustic Classification & Segmentation (ACS) is a audio segmentation tool developed at Brandeis Lab for Linguistics and Computation. The original software can be found at https://github.com/brandeis-llc/acoustic-classification-segmentation .",
"latest_update": "2023-07-24T05:42:05+00:00",
Expand Down
2 changes: 1 addition & 1 deletion docs/_data/apps.json

Large diffs are not rendered by default.

Loading