-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Update README and package.json * Re-generate server for API version 1.0.1 * Update API and tool version in Tool object
- Loading branch information
1 parent
a0290fc
commit 6fd9be3
Showing
7 changed files
with
30 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -13,7 +13,7 @@ def get_tool(): # noqa: E501 | |
""" | ||
tool = Tool( | ||
name="person-name-annotator-example", | ||
version="1.0.0", | ||
version="1.0.1", | ||
license=License.APACHE_2_0, | ||
repository="github:nlpsandbox/person-name-annotator-example", | ||
description="Example implementation of the NLP Sandbox Person " + | ||
|
@@ -22,7 +22,7 @@ def get_tool(): # noqa: E501 | |
author_email="[email protected]", | ||
url="https://github.com/nlpsandbox/person-name-annotator-example", | ||
tool_type="nlpsandbox:person-name-annotator", | ||
tool_api_version="1.0.0" | ||
tool_api_version="1.0.1" | ||
) | ||
return tool, 200 | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -5,19 +5,28 @@ info: | |
name: The NLP Sandbox Team | ||
url: https://nlpsandbox.io | ||
description: | | ||
# Overview | ||
# Introduction | ||
The Person Name Annotator is one of the first type of NLP Tools that can be benchmarked on [nlpsandbox.io](https://nlpsandbox.io). A Person Name Annotator takes as input a clinical note and outputs a list of predicted person name annotations found in the clinical note. This OpenAPI document describes the specification of a Person Name Annotator. This specification includes the schemas of the input and output data, and the conditions that this annotator must meet if you want to benchmark its performance on [nlpsandbox.io](https://nlpsandbox.io). | ||
# Getting Started | ||
The GitHub repository [nlpsandbox/person-name-annotator-example](https://github.com/nlpsandbox/person-name-annotator-example) provides a simple example implementation of a Python-Flask Person Name Annotator. By the end of the tutorial available in this repository, you will have built a Docker image for a simple Person Name Annotator. You will then be able to submit this image to [nlpsandbox.io](https://nlpsandbox.io) to benchmark its performance. | ||
# Benchmarking Requirements | ||
The following conditions must be met by your Person Name Annotator if you want to benchmark its performance on [nlpsandbox.io](https://nlpsandbox.io). | ||
- The endpoint `/` must redirect to `/api/v1/tool`. | ||
- The endpoint `/ui` must redirect to the web interface (UI). | ||
- The output of this tool must be reproducible: a given input should always | ||
generate the same output. | ||
This NLP tool detects references of person names in the clinical note given | ||
as input and returns a list of person name annotations. | ||
- This tool must not attempt to connect to remote server for reproducibility, | ||
robustness, and security reasons. When benchmarked on [nlpsandbox.io](https://nlpsandbox.io), | ||
this tool will not be able to connect to remote servers. | ||
# Examples | ||
- [NLP Sandbox Person Name Annotator (Python)](https://github.com/nlpsandbox/person-name-annotator-example) | ||
- [Person Name Annotator Example (Python)](https://github.com/nlpsandbox/person-name-annotator-example) | ||
license: | ||
name: Apache 2.0 | ||
url: https://github.com/nlpsandbox/nlpsandbox-schemas/blob/develop/LICENSE | ||
title: NLP Sandbox Person Name Annotator API | ||
version: 1.0.0 | ||
version: 1.0.1 | ||
x-logo: | ||
url: https://nlpsandbox.github.io/nlpsandbox-schemas/logo.png | ||
servers: | ||
|
@@ -290,6 +299,7 @@ components: | |
minimum: 0 | ||
type: number | ||
required: | ||
- confidence | ||
- length | ||
- start | ||
- text | ||
|
@@ -362,6 +372,7 @@ components: | |
- ncsa | ||
- unlicense | ||
- zlib | ||
- none | ||
example: apache-2.0 | ||
type: string | ||
ToolType: | ||
|
@@ -383,7 +394,7 @@ components: | |
authorEmail: [email protected] | ||
url: https://example.com | ||
toolType: nlpsandbox:date-annotator | ||
toolApiVersion: 1.0.0 | ||
toolApiVersion: 1.0.1 | ||
properties: | ||
name: | ||
description: The tool name | ||
|
@@ -453,7 +464,7 @@ components: | |
authorEmail: [email protected] | ||
url: https://example.com | ||
toolType: nlpsandbox:date-annotator | ||
toolApiVersion: 1.0.0 | ||
toolApiVersion: 1.0.1 | ||
- name: awesome-nlp-tool | ||
version: 1.0.6 | ||
license: apache-2.0 | ||
|
@@ -463,7 +474,7 @@ components: | |
authorEmail: [email protected] | ||
url: https://example.com | ||
toolType: nlpsandbox:date-annotator | ||
toolApiVersion: 1.0.0 | ||
toolApiVersion: 1.0.1 | ||
properties: | ||
toolDependencies: | ||
description: A list of tools | ||
|