You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Hironsan 65e80b89e2 Specify sort order not to change document order when it is checked 4 years ago
.github Update ISSUE_TEMPLATE 5 years ago
app Specify sort order not to change document order when it is checked 4 years ago
docs Update README.md 5 years ago
frontend Disable left/right shortcut key in input and textarea 4 years ago
nginx Add X-Frame-Options header to prevent clickjacking 5 years ago
tools Merge pull request #333 from CatalystCode/feature/roles 5 years ago
.coveragerc Merge branch 'master' of https://github.com/chakki-works/doccano into authentification and resolves the two little conflicts 5 years ago
.dockerignore Add linter for Dockerfile 5 years ago
.flake8 Add flake8 linter to CI 5 years ago
.gitignore Implement data import from Excel 5 years ago
.travis.yml Add support for MySQL 5 years ago
Dockerfile Add volume for SQLite DB in doccano container 5 years ago
LICENSE Update LICENSE 5 years ago
README.md Update README.md 5 years ago
app.json Implement docker deployment from app.json 5 years ago
awsdeploy.yml ami id, docker ports, instance type 5 years ago
azure-pipelines.yaml Add documentation for pipeline variables 5 years ago
azuredeploy.json Add Sendgrid email backend to Azure deployment 5 years ago
cloudbuild.yaml Attempting Google Run 5 years ago
docker-compose.prod.yml Update compose file version 5 years ago
docker-compose.yml Following Hironsan review, did some change. 5 years ago
environment.yml Removed unnecessary line from environment.yml 5 years ago
heroku.yml Implement docker deployment from app.json 5 years ago
mkdocs.yml Cleanup mkdocs website 5 years ago
package.json Implement Heroku Button 5 years ago
requirements.txt Merge pull request #422 from CatalystCode/enhancement/mysql 5 years ago

README.md

doccano

Codacy Badge Build Status

doccano is an open source text annotation tool for humans. It provides annotation features for text classification, sequence labeling and sequence to sequence tasks. So, you can create labeled data for sentiment analysis, named entity recognition, text summarization and so on. Just create a project, upload data and start annotating. You can build a dataset in hours.

Demo

You can try the annotation demo.

Named Entity Recognition

Features

  • Collaborative annotation
  • Multi-language support
  • Mobile support
  • Emoji 😄 support
  • Dark theme
  • RESTful API

Usage

Two options to run doccano:

  • (Recommended) Docker Compose
  • Docker

Docker Compose

$ git clone https://github.com/doccano/doccano.git
$ cd doccano
$ docker-compose -f docker-compose.prod.yml up

Access http://0.0.0.0/.

Note the superuser account credentials located in the docker-compose.prod.yml file:

ADMIN_USERNAME: "admin"
ADMIN_PASSWORD: "password"

Note: If you want to add annotators, see Frequently Asked Questions

Docker

As a one-time setup, create a Docker container for Doccano:

docker pull chakkiworks/doccano
docker container create --name doccano \
  -e "ADMIN_USERNAME=admin" \
  -e "ADMIN_EMAIL=admin@example.com" \
  -e "ADMIN_PASSWORD=password" \
  -p 8000:8000 chakkiworks/doccano

Next, start Doccano by running the container:

docker container start doccano

To stop the container, run docker container stop doccano -t 5. All data created in the container will persist across restarts.

Access http://127.0.0.1:8000/.

One-click Deployment

Service Button
AWS1 AWS CloudFormation Launch Stack SVG Button
Azure Deploy to Azure
GCP2 GCP Cloud Run PNG Button
Heroku Deploy

Contribution

As with any software, doccano is under continuous development. If you have requests for features, please file an issue describing your request. Also, if you want to see work towards a specific feature, feel free to contribute by working towards it. The standard procedure is to fork the repository, add a feature, fix a bug, then file a pull request that your changes are to be merged into the main repository and included in the next release.

Here are some tips might be helpful. How to Contribute to Doccano Project

Citation

@misc{doccano,
  title={{doccano}: Text Annotation Tool for Human},
  url={https://github.com/doccano/doccano},
  note={Software available from https://github.com/doccano/doccano},
  author={
    Hiroki Nakayama and
    Takahiro Kubo and
    Junya Kamura and
    Yasufumi Taniguchi and
    Xu Liang},
  year={2018},
}

Contact

For help and feedback, please feel free to contact the author.


  1. (1) EC2 KeyPair cannot be created automatically, so make sure you have an existing EC2 KeyPair in one region. Or create one yourself. (2) If you want to access doccano via HTTPS in AWS, here is an instruction. ↩︎

  2. Although this is a very cheap option, it is only suitable for very small teams (up to 80 concurrent requests). Read more on Cloud Run docs. ↩︎