dkalpakchi / textinator Goto Github PK

⚠️ The project undergoes major refactoring. The changes in the new version are likely to be breaking and the dumps from the old versions will not be compatible. ⚠️

Check out some introductory resources:

• Documentation
• Video tutorials
• Interested how Textinator compares to other Open Source annotation tools for NLP? Check our paper published at LREC 2022: https://aclanthology.org/2022.lrec-1.90.pdf

First you will need to install Docker and docker-compose. Afterwards just follow these steps:

1. Clone this repository by running git clone https://github.com/dkalpakchi/Textinator.git or download one of the releases and unpack it.
2. Build and run container in either development or production mode, following the instructions in of the corresponding section below.

The recommended way of deploying Textinator is through building a production version of the Docker container, as described in the Deployment guidelines. Note that the production version is most definitely more secure and reliable than the development version. However, it's not extremely scalable and hosts both database and Textinator instance on the same machine. The ultimate solution would be to use something like Kubernetes, but it is currently not supported out of the box.

A good starting place for familiarizing yourself with a codebase is via our API documentation. The documentation for developers is an ongoing effort, but some established workflows are described in our Development guidelines, (for instance, how to run a development Docker instance).

Want to contribute to Textinator? Check out our Contribution guidelines.

The software is developed in English.

Partial translation is available for these languages (in alphabetical order):

• Russian thanks to Dmytro Kalpakchi
• Swedish thanks to Dmytro Kalpakchi
• Ukrainian thanks to Dmytro Kalpakchi

Upcoming languages

• Dutch
• Spanish

Textinator depends on so many other wonderful open-source projects, that they deserve a special Credits file

@inproceedings{kalpakchi-boye-2022-textinator,
    title = "Textinator: an Internationalized Tool for Annotation and Human Evaluation in Natural Language Processing and Generation",
    author = "Kalpakchi, Dmytro  and
      Boye, Johan",
    booktitle = "Proceedings of the Thirteenth Language Resources and Evaluation Conference",
    month = jun,
    year = "2022",
    address = "Marseille, France",
    publisher = "European Language Resources Association",
    url = "https://aclanthology.org/2022.lrec-1.90",
    pages = "856--866"
}