yujunjun/haystack
1
0
Fork 0
mirror of https://github.com/deepset-ai/haystack.git synced 2025-09-19 13:13:39 +00:00
Code Issues Packages Projects Releases Wiki Activity
haystack/docs/v0.6.0/_src/usage/usage/annotation.md
Markus Paff b752da1cd5
Add docs v0.6.0 (#689) 
* new docs version

* updated directory structure

* Add pipelines page

* Add Finder deprecation suggestion

* header for pipelines file

* Document MySQL support

* Mention DPR train tutorial coming soon

* Mention open distro ES

* Update doc strings regarding similarity fn

* Add link to API docs

* Wrap pipelines docs in box

* add api reference for pipelines

* copied latest version to v0.6.0

* Remove space

* Remove space

* Copy to v0.6.0

Co-authored-by: brandenchan <brandenchan@icloud.com>
2020-12-18 12:47:27 +01:00

1.4 KiB
Raw Blame History

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

Hosted version

Signup here: Haystack Annotation Tool

Local version (Docker)

  1. Configure credentials & database in the 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"

  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.