diff --git a/README.md b/README.md index edfc6dc9..b68ee608 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,34 @@ # doccano -doccano is a document annotation tool. The purpose is making annotation process efficient. First, manually labeling small data in minutes using the labeling interface. Second, train built-in classification model using the labeled data and classify unlabeled data with their probability. Then, sort data in ascending order by the probability. You can efficiently annotate the data. +doccano is an open source text annotation tool for human. It provides annotation features for text classification, sequence labeling and sequence to sequence. So, you can create labeled data for sentiment analysis, named entity recognition, text summarization and so on. Just create project, upload data and start annotation. You can build dataset in hours. -![doccano](docs/demo.png) +## Demo +You can enjoy [annotation demo](http://doccano.herokuapp.com). + +### Sequence labeling + +![Sequence Labeling](http://via.placeholder.com/600x400) + +### Text classification + +![Text Classification](http://via.placeholder.com/600x400) + +### Sequence to sequence + +![Sequence Labeling](http://via.placeholder.com/600x400) ## Features -* Active Learning based annotation +* Collaborative annotation +* Language independent +* (future) Auto labeling ## Requirements * Python3.6+ -* numpy 1.14.3+ -* scikit-learn 0.19.1+ -* scipy 1.1.0+ * django 2.0.5+ - -Put data into [doccano/data](https://github.com/chakki-works/doccano/tree/master/data) directory. +* Google Chrome(highly recommended) ## Installation @@ -29,13 +40,23 @@ $ cd doccano $ pip install -r requirements.txt ``` +create superuser. + +```bash +$ cd app +$ python manage.py createsuperuser +``` + ## Usage First, run web application: ```bash -$ cd doccano/server -$ python run_server.py +$ python manage.py runserver ``` Then, open in your browser. + +## Contribution + +**If you are favorite to doccano, please follow my [GitHub](https://github.com/Hironsan) and [Twitter](https://twitter.com/Hironsan13) account.** Please feel free to contact! \ No newline at end of file