Hiroki Nakayama
a71fbd3e4c
|
4 years ago | |
---|---|---|
.github | 4 years ago | |
app | 4 years ago | |
docs | 4 years ago | |
frontend | 4 years ago | |
nginx | 4 years ago | |
tools | 4 years ago | |
.coveragerc | 5 years ago | |
.dockerignore | 5 years ago | |
.flake8 | 5 years ago | |
.gitignore | 4 years ago | |
.travis.yml | 4 years ago | |
CONTRIBUTING.md | 4 years ago | |
Dockerfile | 5 years ago | |
LICENSE | 5 years ago | |
README.md | 4 years ago | |
app.json | 4 years ago | |
awsdeploy.yml | 4 years ago | |
azure-pipelines.yaml | 5 years ago | |
azuredeploy.json | 4 years ago | |
cloudbuild.yaml | 5 years ago | |
docker-compose.dev.yml | 4 years ago | |
docker-compose.prod.yml | 5 years ago | |
docker-compose.yml | 5 years ago | |
environment.yml | 5 years ago | |
heroku.yml | 5 years ago | |
mkdocs.yml | 4 years ago | |
package.json | 5 years ago | |
requirements.txt | 4 years ago |
README.md
doccano
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.
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, see Frequently Asked Questions
One-click Deployment
Service | Button |
---|---|
AWS1 | |
Azure | |
GCP2 | |
Heroku |
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) 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. ↩︎
-
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. ↩︎