yujunjun/haystack
1
0
Fork 0
mirror of https://github.com/deepset-ai/haystack.git synced 2025-11-03 11:19:57 +00:00
Code Issues Packages Projects Releases Wiki Activity
haystack/annotation_tool
History
Yaser Martinez Palenzuela f5419163e7
Add annotation tool manual to readme (#523) 
* Update README.md

* Update README.md

Co-authored-by: Malte Pietsch <malte.pietsch@deepset.ai>
2020-11-02 10:51:50 +01:00
..
docker-compose.yml
Add Docker setup for the annotation tool (#444)
2020-09-29 14:09:45 +02:00
README.md
Add annotation tool manual to readme (#523)
2020-11-02 10:51:50 +01:00

README.md

Haystack 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.

Setup Annotation Tool with Docker

  1. Configure credentials & database in the docker-compose.yml file:

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"

  1. Run docker-compose by executing docker-compose up.

  2. The UI should be available at localhost:7001.

Usage

The manual (of a slightly earlier version) can be found here. While it doesn't include all latest features, the basic workflow and tips for label quality are still the same.