From 34707aaf0c3f5b1f4d923217ca4d8c45e2fdf4cd Mon Sep 17 00:00:00 2001 From: Liam Cripwell Date: Fri, 25 Oct 2019 16:53:38 +1000 Subject: [PATCH 1/2] some minor readability improvements to intro of readme --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 2b4a85f5..b566dbcb 100644 --- a/README.md +++ b/README.md @@ -3,27 +3,27 @@ [![Codacy Badge](https://api.codacy.com/project/badge/Grade/98a0992c0a254d0ba23fd75631fe2907)](https://app.codacy.com/app/Hironsan/doccano?utm_source=github.com&utm_medium=referral&utm_content=chakki-works/doccano&utm_campaign=Badge_Grade_Dashboard) [![Build Status](https://travis-ci.org/chakki-works/doccano.svg?branch=master)](https://travis-ci.org/chakki-works/doccano) -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 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 enjoy [annotation demo](http://doccano.herokuapp.com). +You can enjoy the [annotation demo](http://doccano.herokuapp.com). ### [Named entity recognition](https://doccano.herokuapp.com/demo/named-entity-recognition/) -First demo is one of the sequence labeling tasks, named-entity recognition. You just select text spans and annotate it. Since doccano supports shortcut key, so you can quickly annotate text spans. +The first demo is a sequence labeling task: named-entity recognition. You just select text spans and annotate them. Doccano supports shortcut keys, so you can quickly annotate text spans. ![Named Entity Recognition](./docs/named_entity_annotation.gif) ### [Sentiment analysis](https://doccano.herokuapp.com/demo/text-classification/) -Second demo is one of the text classification tasks, topic classification. Since there may be more than one category, you can annotate multi-labels. +The second demo is a text classification task: sentiment analysis. Since there may be more than one category, you can annotate multi-labels. ![Text Classification](./docs/text_classification.gif) ### [Machine translation](https://doccano.herokuapp.com/demo/translation/) -Final demo is one of the sequence to sequence tasks, machine translation. Since there may be more than one responses in sequence to sequence tasks, you can create multi responses. +The final demo is a sequence to sequence task: machine translation. Since there may be more than one response in sequence to sequence tasks, you can create multi responses. ![Machine Translation](./docs/translation.gif) @@ -83,13 +83,13 @@ cd doccano To install doccano, there are three options: -**Option1: Pull the production Docker image** +**Option 1: Pull the production Docker image** ```bash docker pull chakkiworks/doccano ``` -**Option2: Setup Python environment** +**Option 2: Setup Python environment** First we need to install the dependencies. Run the following commands: @@ -110,7 +110,7 @@ npm run build cd .. ``` -**Option3: Pull the development Docker-Compose images** +**Option 3: Pull the development Docker-Compose images** ```bash docker-compose pull From 3cb3c81b9bed2ffa270e19d5c3331d58d43ec46d Mon Sep 17 00:00:00 2001 From: Liam Cripwell Date: Fri, 25 Oct 2019 16:58:14 +1000 Subject: [PATCH 2/2] additional minor changes --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b566dbcb..f140d277 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ doccano is an open source text annotation tool for humans. It provides annotatio ## Demo -You can enjoy the [annotation demo](http://doccano.herokuapp.com). +You can try the [annotation demo](http://doccano.herokuapp.com). ### [Named entity recognition](https://doccano.herokuapp.com/demo/named-entity-recognition/) @@ -17,13 +17,13 @@ The first demo is a sequence labeling task: named-entity recognition. You just s ### [Sentiment analysis](https://doccano.herokuapp.com/demo/text-classification/) -The second demo is a text classification task: sentiment analysis. Since there may be more than one category, you can annotate multi-labels. +The second demo is a text classification task: sentiment analysis. Since there may be more than one category, you can annotate with multiple labels. ![Text Classification](./docs/text_classification.gif) ### [Machine translation](https://doccano.herokuapp.com/demo/translation/) -The final demo is a sequence to sequence task: machine translation. Since there may be more than one response in sequence to sequence tasks, you can create multi responses. +The final demo is a sequence to sequence task: machine translation. Since there may be more than one response in sequence to sequence tasks, you can create multiple responses. ![Machine Translation](./docs/translation.gif)