diff --git a/annotation_tool/README.md b/annotation_tool/README.md index 9285da915..bc866eca5 100644 --- a/annotation_tool/README.md +++ b/annotation_tool/README.md @@ -1,13 +1,18 @@ -# Haystack Annotation Tool +# Annotation Tool -This document describes setting up the Haystack Annotation Tool with the publicly available Docker Images. Alternatively, -a hosted version of the tool is available at https://annotate.deepset.ai/login. +- Create labels with different techniques: Come up with questions (+ answers) while reading passages (SQuAD style) or have a set of predefined questions and look for answers in the document (~ Natural Questions). +- Structure your work via organizations, projects, users +- Upload your documents or import labels from an existing SQuAD-style dataset +- Export your labels in SQuAD Format +![image](../docs/_src//img/annotation_tool.png) +# Hosted version + Signup here: [Haystack Annotation Tool](https://annotate.deepset.ai/login) -# Setup Annotation Tool with Docker +# Local version (Docker) -1. Configure credentials & database in the `docker-compose.yml` file: +1. Configure credentials & database in the [`docker-compose.yml`](https://github.com/deepset-ai/haystack/blob/master/annotation_tool/docker-compose.yml): The credentials should match in database image and application configuration. diff --git a/docs/_src/usage/usage/annotation.md b/docs/_src/usage/usage/annotation.md new file mode 100644 index 000000000..4504ab0cd --- /dev/null +++ b/docs/_src/usage/usage/annotation.md @@ -0,0 +1,38 @@ +# Annotation Tool + +- Create labels with different techniques: Come up with questions (+ answers) while reading passages (SQuAD style) or have a set of predefined questions and look for answers in the document (~ Natural Questions). +- Structure your work via organizations, projects, users +- Upload your documents or import labels from an existing SQuAD-style dataset +- Export your labels in SQuAD Format + +![image](../../img/annotation_tool.png) + +# Hosted version + Signup here: [Haystack Annotation Tool](https://annotate.deepset.ai/login) + +# Local version (Docker) + +1. Configure credentials & database in the [`docker-compose.yml`](https://github.com/deepset-ai/haystack/blob/master/annotation_tool/docker-compose.yml): + +The credentials should match in database image and application configuration. + + DEFAULT_ADMIN_EMAIL: "example@example.com" + DEFAULT_ADMIN_PASSWORD: "DEMO-PASSWORD" + + PROD_DB_NAME: "databasename" + PROD_DB_USERNAME: "somesafeuser" + PROD_DB_PASSWORD: "somesafepassword" + + + POSTGRES_USER: "somesafeuser" + POSTGRES_PASSWORD: "somesafepassword" + POSTGRES_DB: "databasename" + + +2. Run docker-compose by executing `docker-compose up`. + + +3. The UI should be available at `localhost:7001`. + +# Usage +The manual (of a slightly earlier version) can be found [here](https://drive.google.com/file/d/1Wv3OIC0Z7ibHIzOm9Xw_r0gjTFmpl-33/view). While it doesn't include all latest features, the basic workflow and tips for label quality are still the same.