Skip to content

Create PHI Annotator#1

Merged
tschaffter merged 10 commits intomainfrom
adapt-to-phi-annotator
Aug 11, 2021
Merged

Create PHI Annotator#1
tschaffter merged 10 commits intomainfrom
adapt-to-phi-annotator

Conversation

@tschaffter
Copy link
Copy Markdown
Member

This PR starts with the GitHub repository https://github.com/nlpsandbox/date-annotator-example-java and modify this tool to create another tool that implements the NLP Sandbox PHI Annotator API.

The history of events is available below and can be used as a reference for similar operations.

@tschaffter tschaffter self-assigned this Aug 11, 2021
@tschaffter
Copy link
Copy Markdown
Member Author

tschaffter commented Aug 11, 2021

At this point, this example PHI annotator can be built and started using the instructions already available in the README.

cd server/
mvn package
java -jar target/openapi-spring-1.2.0.jar

The tool is then available at http://localhost:8080/ui

The endpoints that work at this point are the one implemented by the date annotator example tool that this tool is based on.

Next step is to fix/implement the following endpoints that were not part of the date annotator tool:

  • Person name annotation
  • Location annotation
  • Contact annotation
  • ID annotation

@tschaffter
Copy link
Copy Markdown
Member Author

For now all the internal annotators - but dates - return an empty array. Checking that this is the case and that the response code return is 200 (success) by starting the tool and accessing http://localhost:8080.

@tschaffter
Copy link
Copy Markdown
Member Author

We updated the README. The missing information is the URL to the docker image that will be generated by this GH repository using the CI/CD workflow. This image will be hosted on Synapse and will get a unique ID that will be part of its URL. Once we have it, we can update the URL in the README.

@tschaffter
Copy link
Copy Markdown
Member Author

Added GitHub secrets to this repository so that GitHub is authorized to push the Docker image to Synapse after building it in the CI/CD workflow. See the section Configuring the CI/CD workflow in the README.

@tschaffter
Copy link
Copy Markdown
Member Author

We should now have successfully created an example tool that follow the NLP Sandbox PHI Annotator API. After merging this PR to the default branch, the CI/CD workflow should start, build the docker image and push it to Synapse. We will then be able to submit the image to the NLP Sandbox to evaluate the performance directly from Synapse.

@tschaffter tschaffter merged commit 4119b2c into main Aug 11, 2021
@tschaffter tschaffter deleted the adapt-to-phi-annotator branch August 11, 2021 23:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant