From fb6d20bbd76510c117f2ed6cda08201af4b7926f Mon Sep 17 00:00:00 2001 From: tschaffter Date: Tue, 23 Feb 2021 09:40:05 -0800 Subject: [PATCH] Update format of API description --- openapi/date-annotator/openapi.yaml | 43 ++++++++++--------- openapi/person-name-annotator/openapi.yaml | 41 +++++++++--------- .../physical-address-annotator/openapi.yaml | 37 ++++++++-------- 3 files changed, 61 insertions(+), 60 deletions(-) diff --git a/openapi/date-annotator/openapi.yaml b/openapi/date-annotator/openapi.yaml index 3df0ce2b..376d4725 100644 --- a/openapi/date-annotator/openapi.yaml +++ b/openapi/date-annotator/openapi.yaml @@ -15,44 +15,45 @@ info: # Introduction The Date Annotator is one of the first type of NLP Tools that can be - benchmarked on [nlpsandbox.io]. A Date Annotator takes as input a clinical - note and outputs a list of predicted date annotations found in the clinical - note. This OpenAPI document describes the specification of a Date 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]. + benchmarked on [nlpsandbox.io](https://nlpsandbox.io). A Date Annotator + takes as input a clinical note and outputs a list of predicted date + annotations found in the clinical note. This OpenAPI document describes the + specification of a Date 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/date-annotator-example] provides a simple - example implementation of a Python-Flask Date Annotator. By the end of the - tutorial available in this repository, you will have built a Docker image - for a simple Date Annotator. You will then be able to submit this image to - [nlpsandbox.io] to benchmark its performance. + The GitHub repository + [nlpsandbox/date-annotator-example](https://github.com/nlpsandbox/date-annotator-example) + provides a simple example implementation of a Python-Flask Date Annotator. + By the end of the tutorial available in this repository, you will have built + a Docker image for a simple Date 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 Date Annotator if you want to - benchmark its performance on [nlpsandbox.io]. + 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 tool must not attempt to connect to remote server for reproducibility, - robustness, and security reason. When benchmark on [nlpsandbox.io], this - tool will be prevented from connecting to remote servers. + robustness, and security reasons. When benchmarked on [nlpsandbox.io](https://nlpsandbox.io), + this tool will not be able to connect to remote servers. # Examples - - [Date Annotator Example (Python)] - - [Date Annotator Example (Java)] + - [Date Annotator Example (Python)](https://github.com/nlpsandbox/date-annotator-example) - - [nlpsandbox.io]: https://nlpsandbox.io - [nlpsandbox/date-annotator-example]: https://github.com/nlpsandbox/date-annotator-example - [Date Annotator Example (Python)]: https://github.com/nlpsandbox/date-annotator-example - [Date Annotator Example (Java)]: https://github.com/nlpsandbox/date-annotator-example-java + - [Date Annotator Example (Java)](https://github.com/nlpsandbox/date-annotator-example-java) tags: - name: HealthCheck description: Operations about health checks diff --git a/openapi/person-name-annotator/openapi.yaml b/openapi/person-name-annotator/openapi.yaml index e584710f..1324ecc2 100644 --- a/openapi/person-name-annotator/openapi.yaml +++ b/openapi/person-name-annotator/openapi.yaml @@ -15,42 +15,43 @@ info: # Introduction The Person Name Annotator is one of the first type of NLP Tools that can be - benchmarked on [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]. + 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] 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] to benchmark its performance. + 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]. + 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 tool must not attempt to connect to remote server for reproducibility, - robustness, and security reason. When benchmark on [nlpsandbox.io], this - tool will be prevented from connecting to remote servers. + robustness, and security reasons. When benchmarked on [nlpsandbox.io](https://nlpsandbox.io), + this tool will not be able to connect to remote servers. # Examples - - [Person Name Annotator Example (Python)] - - - [nlpsandbox.io]: https://nlpsandbox.io - [nlpsandbox/person-name-annotator-example]: https://github.com/nlpsandbox/person-name-annotator-example - [Person Name Annotator Example (Python)]: https://github.com/nlpsandbox/person-name-annotator-example + - [Person Name Annotator Example (Python)](https://github.com/nlpsandbox/person-name-annotator-example) tags: - name: HealthCheck description: Operations about health checks diff --git a/openapi/physical-address-annotator/openapi.yaml b/openapi/physical-address-annotator/openapi.yaml index 72fdf1a7..57d961cd 100644 --- a/openapi/physical-address-annotator/openapi.yaml +++ b/openapi/physical-address-annotator/openapi.yaml @@ -15,44 +15,43 @@ info: # Introduction The Physical Address Annotator is one of the first type of NLP Tools that - can be benchmarked on [nlpsandbox.io]. A Physical Address Annotator takes as - input a clinical note and outputs a list of predicted physical address - annotations found in the clinical note. This OpenAPI document describes the - specification of a Physical Address 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]. + can be benchmarked on [nlpsandbox.io](https://nlpsandbox.io). A Physical + Address Annotator takes as input a clinical note and outputs a list of + predicted physical address annotations found in the clinical note. This + OpenAPI document describes the specification of a Physical Address + 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/physical-address-annotator-example] + The GitHub repository + [nlpsandbox/physical-address-annotator-example](https://github.com/nlpsandbox/physical-address-annotator-example) provides a simple example implementation of a Python-Flask Physical Address Annotator. By the end of the tutorial available in this repository, you will have built a Docker image for a simple Physical Address Annotator. You will - then be able to submit this image to [nlpsandbox.io] to benchmark its - performance. + 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 Physical Address Annotator if - you want to benchmark its performance on [nlpsandbox.io]. + 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 tool must not attempt to connect to remote server for reproducibility, - robustness, and security reason. When benchmark on [nlpsandbox.io], this - tool will be prevented from connecting to remote servers. + robustness, and security reasons. When benchmarked on [nlpsandbox.io](https://nlpsandbox.io), + this tool will not be able to connect to remote servers. # Examples - - [Physical Address Annotator Example (Python)] - - - [nlpsandbox.io]: https://nlpsandbox.io - [nlpsandbox/physical-address-annotator-example]: https://github.com/nlpsandbox/physical-address-annotator-example - [Physical Address Annotator Example (Python)]: https://github.com/nlpsandbox/physical-address-annotator-example + - [Physical Address Annotator Example (Python)](https://github.com/nlpsandbox/physical-address-annotator-example) tags: - name: HealthCheck description: Operations about health checks