Skip to content

Commit cbe4012

Browse files
bactbact
authored
Update README.md
1 parent 6c95beb commit cbe4012

File tree

1 file changed

+22
-27
lines changed

1 file changed

+22
-27
lines changed

‎README.md‎

Lines changed: 22 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,16 @@
44
<h1>PyThaiNLP: Thai Natural Language Processing in Python</h1>
55
</div>
66

7-
[![Python 3.6](https://img.shields.io/badge/python-3.6-blue.svg)](https://www.python.org/downloads/release/python-360/)
87
[![pypi](https://img.shields.io/pypi/v/pythainlp.svg)](https://pypi.python.org/pypi/pythainlp)
9-
[![Downloads](https://pepy.tech/badge/pythainlp/month)](https://pepy.tech/project/pythainlp)
8+
[![Python 3.6](https://img.shields.io/badge/python-3.6-blue.svg)](https://www.python.org/downloads/release/python-360/)
109
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
11-
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2FPyThaiNLP%2Fpythainlp.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2FPyThaiNLP%2Fpythainlp)
10+
[![Downloads](https://pepy.tech/badge/pythainlp/month)](https://pepy.tech/project/pythainlp)
11+
1212
[![Build status](https://ci.appveyor.com/api/projects/status/9g3mfcwchi8em40x?svg=true)](https://ci.appveyor.com/project/wannaphongcom/pythainlp-9y1ch)
13-
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/cb946260c87a4cc5905ca608704406f7)](https://www.codacy.com/app/pythainlp/pythainlp_2)
1413
[![Coverage Status](https://coveralls.io/repos/github/PyThaiNLP/pythainlp/badge.svg?branch=dev)](https://coveralls.io/github/PyThaiNLP/pythainlp?branch=dev)
14+
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/cb946260c87a4cc5905ca608704406f7)](https://www.codacy.com/app/pythainlp/pythainlp_2)
15+
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2FPyThaiNLP%2Fpythainlp.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2FPyThaiNLP%2Fpythainlp)
16+
1517
[![Google Colab Badge](https://badgen.net/badge/Launch%20Quick%20Start%20Guide/on%20Google%20Colab/blue?icon=terminal)](https://colab.research.google.com/github/PyThaiNLP/tutorials/blob/master/source/notebooks/pythainlp_get_started.ipynb)
1618
[![DOI](https://zenodo.org/badge/61813823.svg)](https://zenodo.org/badge/latestdoi/61813823)
1719

@@ -28,13 +30,13 @@ PyThaiNLP เป็นไลบารีภาษาไพทอนสำหร
2830
| [2.2.2](https://github.com/PyThaiNLP/pythainlp/releases) | Stable | [Change Log](https://github.com/PyThaiNLP/pythainlp/issues/330) |
2931
| [`dev`](https://github.com/PyThaiNLP/pythainlp/tree/dev) | Release Candidate for 2.3 | [Change Log](https://github.com/PyThaiNLP/pythainlp/issues/445) |
3032

31-
Please follow our [PyThaiNLP](https://www.facebook.com/pythainlp/) fanpage for more and recent updates.
33+
Please follow our [PyThaiNLP Facebook page](https://www.facebook.com/pythainlp/) for more updates.
3234

3335
## Getting Started with PyThaiNLP
3436

3537
We provide [PyThaiNLP Get Started Tutorial](https://www.thainlp.org/pythainlp/tutorials/notebooks/pythainlp_get_started.html) for exploring features in PyThaiNLP; We also have tutorials for specific tasks. Please visit [our tutorial page](https://www.thainlp.org/pythainlp/tutorials).
3638

37-
Latest document can be at [https://thainlp.org/pythainlp/docs/2.2/](https://thainlp.org/pythainlp/docs/2.2/).
39+
Latest document is available at [https://thainlp.org/pythainlp/docs/2.2/](https://thainlp.org/pythainlp/docs/2.2/).
3840

3941
We try to make the package easy to use as much as possible; therefore, some additional data (like word lists and language models) may get automatically download during runtime. PyThaiNLP caches additional data under the directory `~/pythainlp-data` by default, but the user can change the value by specifying the environment variable `PYTHAINLP_DATA_DIR`. See corpus catalog at [PyThaiNLP/pythainlp-corpus](https://github.com/PyThaiNLP/pythainlp-corpus).
4042

@@ -62,37 +64,31 @@ Please see [our tutorials](https://www.thainlp.org/pythainlp/tutorials) on how t
6264

6365
## Installation
6466

65-
PyThaiNLP uses PyPI as its main distribution channel, see [https://pypi.org/project/pythainlp/](https://pypi.org/project/pythainlp/)
66-
67-
### Stable Release
68-
6967
```sh
70-
pip install pythainlp
68+
pip install --upgrade pythainlp
7169
```
7270

73-
### Development Pre-release
71+
This will install the latest stable release of PyThaiNLP.
72+
PyThaiNLP uses pip as its package manger and PyPI as its main distribution channel, see [https://pypi.org/project/pythainlp/](https://pypi.org/project/pythainlp/)
7473

75-
```sh
76-
pip install --upgrade --pre pythainlp
77-
```
74+
Install different releases:
7875

79-
### Fresh from Dev Branch
80-
81-
```sh
82-
pip install https://github.com/PyThaiNLP/pythainlp/archive/dev.zip
83-
```
76+
- Stable release: `pip install --upgrade pythainlp`
77+
- Pre-release (near ready): `pip install --upgrade --pre pythainlp`
78+
- Development (likely to break things): `pip install https://github.com/PyThaiNLP/pythainlp/archive/dev.zip`
8479

8580
### Installation Options
8681

87-
For some functionalities, like named-entity recognition, extra packages may be needed. Install them with these install options:
82+
Some functionalities, like named-entity recognition, may require extra packages. To install those requirements, specify a set of `[name]` immediately after `pythainlp`:
8883

8984
```sh
9085
pip install pythainlp[extra1,extra2,...]
9186
```
9287

9388
<details>
94-
<summary>where `extras` can be</summary>
95-
89+
<summary>List of possible `extras`</summary>
90+
91+
- `full` (install everything)
9692
- `attacut` (to support attacut, a fast and accurate tokenizer)
9793
- `benchmarks` (for [word tokenization benchmarking](tokenization-benchmark.md))
9894
- `icu` (for ICU, International Components for Unicode, support in transliteration and tokenization)
@@ -101,7 +97,6 @@ pip install pythainlp[extra1,extra2,...]
10197
- `thai2fit` (for Thai word vector)
10298
- `thai2rom` (for machine-learnt romanization)
10399
- `wordnet` (for Thai WordNet API)
104-
- `full` (install everything)
105100
</details>
106101

107102
For dependency details, look at `extras` variable in [`setup.py`](https://github.com/PyThaiNLP/pythainlp/blob/dev/setup.py).
@@ -161,8 +156,8 @@ or BibTeX entry:
161156
| | License |
162157
|:---|:----|
163158
| PyThaiNLP Source Code and Notebooks | [Apache Software License 2.0](https://github.com/PyThaiNLP/pythainlp/blob/dev/LICENSE) |
164-
| All corpora, datasets, and documentations created by PyThaiNLP | [Creative Commons Zero 1.0 Universal Public Domain Dedication Licensei (CC0)](https://creativecommons.org/publicdomain/zero/1.0/)|
165-
| All language models created by PyThaiNLP | [Creative Commons Attribution 4.0 International Public License (CC-by)](https://creativecommons.org/licenses/by/4.0/) |
159+
| Corpora, datasets, and documentations created by PyThaiNLP | [Creative Commons Zero 1.0 Universal Public Domain Dedication Licensei (CC0)](https://creativecommons.org/publicdomain/zero/1.0/)|
160+
| Language models created by PyThaiNLP | [Creative Commons Attribution 4.0 International Public License (CC-by)](https://creativecommons.org/licenses/by/4.0/) |
166161
| Other corpora and models that may included with PyThaiNLP | See [Corpus License](https://github.com/PyThaiNLP/pythainlp/blob/dev/pythainlp/corpus/corpus_license.md) |
167162

168163
## Sponsors
@@ -175,4 +170,4 @@ Since 2019, our contributors Korakot Chaovavanich and Lalita Lowphansirikul have
175170

176171
<div align="center">
177172
Made with ❤️ | PyThaiNLP Team 💻 | "We build Thai NLP" 🇹🇭
178-
</div>
173+
</div>

0 commit comments

Comments
 (0)