Skip to content

Commit 6fec0e3

Browse files
authored
Merge pull request doccano#421 from liamcripwell/documentation/readme-intro-readability
Documentation/readme intro readability
2 parents 59b8564 + 3cb3c81 commit 6fec0e3

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,27 +3,27 @@
33
[![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)
44
[![Build Status](https://travis-ci.org/chakki-works/doccano.svg?branch=master)](https://travis-ci.org/chakki-works/doccano)
55

6-
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.
6+
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.
77

88
## Demo
99

10-
You can enjoy [annotation demo](http://doccano.herokuapp.com).
10+
You can try the [annotation demo](http://doccano.herokuapp.com).
1111

1212
### [Named entity recognition](https://doccano.herokuapp.com/demo/named-entity-recognition/)
1313

14-
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.
14+
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.
1515

1616
![Named Entity Recognition](./docs/named_entity_annotation.gif)
1717

1818
### [Sentiment analysis](https://doccano.herokuapp.com/demo/text-classification/)
1919

20-
Second demo is one of the text classification tasks, topic classification. Since there may be more than one category, you can annotate multi-labels.
20+
The second demo is a text classification task: sentiment analysis. Since there may be more than one category, you can annotate with multiple labels.
2121

2222
![Text Classification](./docs/text_classification.gif)
2323

2424
### [Machine translation](https://doccano.herokuapp.com/demo/translation/)
2525

26-
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.
26+
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.
2727

2828
![Machine Translation](./docs/translation.gif)
2929

@@ -83,13 +83,13 @@ cd doccano
8383

8484
To install doccano, there are three options:
8585

86-
**Option1: Pull the production Docker image**
86+
**Option 1: Pull the production Docker image**
8787

8888
```bash
8989
docker pull chakkiworks/doccano
9090
```
9191

92-
**Option2: Setup Python environment**
92+
**Option 2: Setup Python environment**
9393

9494
First we need to install the dependencies. Run the following commands:
9595

@@ -110,7 +110,7 @@ npm run build
110110
cd ..
111111
```
112112

113-
**Option3: Pull the development Docker-Compose images**
113+
**Option 3: Pull the development Docker-Compose images**
114114

115115
```bash
116116
docker-compose pull

0 commit comments

Comments
 (0)