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.
 
 
 
 
 
 
Hiroki Nakayama 42ff8337b0
Merge pull request #832 from kuraga/patch-1
4 years ago
.github Update repository name 4 years ago
app Merge pull request #766 from cgill95/feature/annotation_approver_editing 4 years ago
docs FAQ correction 4 years ago
frontend Merge branch 'master' into pull/691 4 years ago
nginx Merge pull request #474 from avant1/keep-custom-port-in-redirect 4 years ago
tools Added flag for allowing downgrades while using apt 4 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 Added user completed data 4 years ago
.travis.yml Fix mkdocs and mkdocs-material version 4 years ago
CONTRIBUTING.md Create CONTRIBUTING.md 4 years ago
Dockerfile Add volume for SQLite DB in doccano container 5 years ago
LICENSE Update LICENSE 5 years ago
README.md Merge branch 'master' into patch-4b 4 years ago
app.json Update repository name 4 years ago
awsdeploy.yml Update repository name 4 years ago
azure-pipelines.yaml Add documentation for pipeline variables 5 years ago
azuredeploy.json Update repository name 4 years ago
cloudbuild.yaml Attempting Google Run 5 years ago
docker-compose.dev.yml Added username at top 4 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 Update repository name 4 years ago
package.json Implement Heroku Button 5 years ago
requirements.txt Add API document generator, resolves #299, resolves #646 4 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.

Demo image

Features

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

Usage

Two options to run doccano:

  • production,
  • development.

To use doccano, please follow:

Install dependencies

You need to install dependencies:

Get the code

You need to clone the repository:

$ git clone https://github.com/doccano/doccano.git
$ cd doccano

Note for Windows developers: Be sure to configure git to correctly handle line endings or you may encounter status code 127 errors while running the services in future steps. Running with the git config options below will ensure your git directory correctly handles line endings.

git clone https://github.com/doccano/doccano.git --config core.autocrlf=input

Production

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

ADMIN_USERNAME: "admin"
ADMIN_PASSWORD: "password"

Run doccano:

$ docker-compose -f docker-compose.prod.yml up

Go to http://0.0.0.0/.

Development

Set the superuser account credentials in the docker-compose.dev.yml file:

ADMIN_USERNAME: "admin"
ADMIN_PASSWORD: "password"

Run Doccano:

$ docker-compose -f docker-compose.dev.yml up

Go to http://127.0.0.1:3000/.

Add annotators (optionally)

If you want to add annotators/annotation approvers, see Frequently Asked Questions

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. ↩︎