Git Product home page Git Product logo

doccano's Introduction

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

Go to 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

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

Docker

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

docker pull doccano/doccano
docker container create --name doccano \
  -e "ADMIN_USERNAME=admin" \
  -e "[email protected]" \
  -e "ADMIN_PASSWORD=password" \
  -p 8000:8000 doccano/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.

Go to http://127.0.0.1:8000/.

For Developers

You can setup local development environment as follows:

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

Go to http://127.0.0.1:3000/.

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.

Footnotes

  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. โ†ฉ

doccano's People

Contributors

hironsan avatar c-w avatar bramblexu avatar erikamenezes avatar margaretmeehan avatar serzh avatar icoxfog417 avatar fnocera avatar clarus avatar kslhacks avatar liamcripwell avatar dependabot[bot] avatar guillim avatar vinayaugustine avatar armanrahman22 avatar a-shkarupin avatar xinyi2016 avatar taise avatar sudodoki avatar joshuapostel avatar almeta-io avatar meseta avatar codacy-badger avatar cicorias avatar rbinrais avatar matthewpick avatar louisguitton avatar avant1 avatar dimidd avatar cteicher-m avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.