Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/doccano/doccano

Open source annotation tool for machine learning practitioners.
https://github.com/doccano/doccano

annotation-tool data-labeling dataset datasets machine-learning natural-language-processing nuxt nuxtjs python text-annotation vue vuejs

Last synced: 11 days ago
JSON representation

Open source annotation tool for machine learning practitioners.

Host: GitHub
URL: https://github.com/doccano/doccano
Owner: doccano
License: mit
Created: 2018-05-09T06:10:05.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2024-07-28T07:36:28.000Z (3 months ago)
Last Synced: 2024-08-07T15:06:16.204Z (3 months ago)
Topics: annotation-tool, data-labeling, dataset, datasets, machine-learning, natural-language-processing, nuxt, nuxtjs, python, text-annotation, vue, vuejs
Language: Python
Homepage:
Size: 53.7 MB
Stars: 9,299
Watchers: 131
Forks: 1,697
Open Issues: 341
Metadata Files:
- Readme: README.md
- Contributing: docs/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: docs/CODE_OF_CONDUCT.md
- Roadmap: docs/roadmap.md

Awesome Lists containing this project

awesome-repositories - doccano/doccano
awesome-nlpbr - Doccano Annotation Tool
open-production-web-projects - Doccano - Open source text annotation tool for machine learning practitioner. (Python / Django)
awesome-starred - doccano/doccano - Open source annotation tool for machine learning practitioners. (vuejs)
awesome-production-machine-learning - Doccano - Open source text annotation tools for humans, providing functionality for sentiment analysis, named entity recognition, and machine translation. (Data Labelling and Synthesis)

README

        


  



# doccano

[![Codacy Badge](https://app.codacy.com/project/badge/Grade/35ac8625a2bc4eddbff23dbc61bc6abb)](https://www.codacy.com/gh/doccano/doccano/dashboard?utm_source=github.com&utm_medium=referral&utm_content=doccano/doccano&utm_campaign=Badge_Grade)

[![doccano CI](https://github.com/doccano/doccano/actions/workflows/ci.yml/badge.svg)](https://github.com/doccano/doccano/actions/workflows/ci.yml)

doccano is an open-source text annotation tool for humans. It provides annotation features for text classification, sequence labeling, and sequence to sequence tasks. 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

Try the [annotation demo](http://doccano.herokuapp.com).

![Demo image](https://raw.githubusercontent.com/doccano/doccano/master/docs/images/demo/demo.gif)

## Documentation

Read the documentation at .

## Features

- Collaborative annotation

- Multi-language support

- Mobile support

- Emoji :smile: support

- Dark theme

- RESTful API

## Usage

There are three options to run doccano:

- pip (Python 3.8+)

- Docker

- Docker Compose

### pip

To install doccano, run:

```bash

pip install doccano

```

By default, SQLite 3 is used for the default database. If you want to use PostgreSQL, install the additional dependencies:

```bash

pip install 'doccano[postgresql]'

```

and set the `DATABASE_URL` environment variable according to your PostgreSQL credentials:

```bash

DATABASE_URL="postgres://${POSTGRES_USER}:${POSTGRES_PASSWORD}@${POSTGRES_HOST}:${POSTGRES_PORT}/${POSTGRES_DB}?sslmode=disable"

```

After installation, run the following commands:

```bash

# Initialize database.

doccano init

# Create a super user.

doccano createuser --username admin --password pass

# Start a web server.

doccano webserver --port 8000

```

In another terminal, run the command:

```bash

# Start the task queue to handle file upload/download.

doccano task

```

Go to .

### Docker

As a one-time setup, create a Docker container as follows:

```bash

docker pull doccano/doccano

docker container create --name doccano \

  -e "ADMIN_USERNAME=admin" \

  -e "[email protected]" \

  -e "ADMIN_PASSWORD=password" \

  -v doccano-db:/data \

  -p 8000:8000 doccano/doccano

```

Next, start doccano by running the container:

```bash

docker container start doccano

```

Go to .

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

If you want to use the latest features, specify the `nightly` tag:

```bash

docker pull doccano/doccano:nightly

```

### Docker Compose

You need to install Git and clone the repository:

```bash

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.

```bash

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

```

Then, create an `.env` file with variables in the following format (see [./docker/.env.example](https://github.com/doccano/doccano/blob/master/docker/.env.example)):

```plain

# platform settings

ADMIN_USERNAME=admin

ADMIN_PASSWORD=password

[email protected]

# rabbit mq settings

RABBITMQ_DEFAULT_USER=doccano

RABBITMQ_DEFAULT_PASS=doccano

# database settings

POSTGRES_USER=doccano

POSTGRES_PASSWORD=doccano

POSTGRES_DB=doccano

```

After running the following command, access .

```bash

docker-compose -f docker/docker-compose.prod.yml --env-file .env up

```

### One-click Deployment

| Service | Button |

|---------|---|

| AWS[^1]   | [![AWS CloudFormation Launch Stack SVG Button](https://cdn.rawgit.com/buildkite/cloudformation-launch-stack-button-svg/master/launch-stack.svg)](https://console.aws.amazon.com/cloudformation/home?#/stacks/new?stackName=doccano&templateURL=https://doccano.s3.amazonaws.com/public/cloudformation/template.aws.yaml)  |

| Heroku  | [![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://dashboard.heroku.com/new?template=https%3A%2F%2Fgithub.com%2Fdoccano%2Fdoccano)  |

> [^1]: (1) EC2 KeyPair cannot be created automatically, so make sure you have an existing EC2 KeyPair in one region. Or [create one yourself](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html#having-ec2-create-your-key-pair). (2) If you want to access doccano via HTTPS in AWS, here is an [instruction](https://github.com/doccano/doccano/wiki/HTTPS-setting-for-doccano-in-AWS).

## FAQ

- [How to create a user](https://doccano.github.io/doccano/faq/#how-to-create-a-user)

- [How to add a user to your project](https://doccano.github.io/doccano/faq/#how-to-add-a-user-to-your-project)

- [How to change the password](https://doccano.github.io/doccano/faq/#how-to-change-the-password)

See the [documentation](https://doccano.github.io/doccano/) for details.

## 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](https://github.com/doccano/doccano/wiki/How-to-Contribute-to-Doccano-Project)

## Citation

```tex

@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, feel free to contact [the author](https://github.com/Hironsan).