Skip to content

Commit b73f936

Browse files
committed
Update README and setup.py
1 parent 5ac8017 commit b73f936

File tree

3 files changed

+43
-7
lines changed

3 files changed

+43
-7
lines changed

README-pypi.md

Lines changed: 31 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
![PyThaiNLP Logo](https://avatars0.githubusercontent.com/u/32934255?s=200&v=4)
22

3-
# PyThaiNLP 1.8.0
3+
# PyThaiNLP 2.0
44

55
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/cb946260c87a4cc5905ca608704406f7)](https://www.codacy.com/app/pythainlp/pythainlp_2?utm_source=github.com&utm_medium=referral&utm_content=PyThaiNLP/pythainlp&utm_campaign=Badge_Grade)[![pypi](https://img.shields.io/pypi/v/pythainlp.svg)](https://pypi.python.org/pypi/pythainlp)
66
[![Build Status](https://travis-ci.org/PyThaiNLP/pythainlp.svg?branch=develop)](https://travis-ci.org/PyThaiNLP/pythainlp)
@@ -12,24 +12,51 @@ PyThaiNLP is a Python library for natural language processing (NLP) of Thai lang
1212

1313
PyThaiNLP includes Thai word tokenizers, transliterators, soundex converters, part-of-speech taggers, and spell checkers.
1414

15-
## What's new in version 1.8 ?
15+
## What's new in version 2.0 ?
1616

1717
- New NorvigSpellChecker spell checker class, which can be initialized with custom dictionary.
1818
- Terminate Python 2 support. Remove all Python 2 compatibility code.
1919
- Remove old, obsolated, deprecated, and experimental code.
20-
- see [PyThaiNLP 1.8 change log](https://github.com/PyThaiNLP/pythainlp/issues/118)
20+
- Thai2fit (Upgrade ULMFiT-related codes to fastai 1.0)
21+
- ThaiNER 1.0
22+
- Remove sentiment analysis
23+
- Improved word_tokenize (newmm, mm) and dict_word_tokenize
24+
- Improved POS-tagging
25+
- More and improved examples
26+
- see [PyThaiNLP 2.0 change log](https://github.com/PyThaiNLP/pythainlp/issues/118)
2127

2228
## Install
2329

30+
For stable version:
31+
2432
```sh
2533
pip install pythainlp
2634
```
2735

36+
For some advanced functionalities, like word vector, extra packages may be needed. Install them with these options during pip install:
37+
38+
```
39+
pip install pythainlp[extra1,extra2,...]
40+
```
41+
42+
where extras can be
43+
44+
- `artagger` (to support artagger part-of-speech tagger)*
45+
- `deepcut` (to support deepcut machine-learnt tokenizer)
46+
- `icu` (for ICU support in transliteration and tokenization)
47+
- `ipa` (for International Phonetic Alphabet support in transliteration)
48+
- `ml` (to support fastai 1.0.22 ULMFiT models)
49+
- `ner` (for named-entity recognizer)
50+
- `thai2fit` (for Thai word vector)
51+
- `thai2rom` (for machine-learnt romanization)
52+
- `full` (install everything)
53+
2854
**Note for Windows**: `marisa-trie` wheels can be obtained from https://www.lfd.uci.edu/~gohlke/pythonlibs/#marisa-trie
2955
Install it with pip, for example: `pip install marisa_trie‑0.7.5‑cp36‑cp36m‑win32.whl`
3056

3157
## Links
3258

33-
- Docs: https://thainlp.org/pythainlp/docs/1.7/
59+
- User guide : [English](https://colab.research.google.com/drive/1MQ10D1mJC5r1vQAHcj4ShoRS14vz8ZF-) , [ภาษาไทย](https://colab.research.google.com/drive/1rEkB2Dcr1UAKPqz4bCghZV7pXx2qxf89)
60+
- Docs: https://thainlp.org/pythainlp/docs/2.0/
3461
- GitHub: https://github.com/PyThaiNLP/pythainlp
3562
- Issues: https://github.com/PyThaiNLP/pythainlp/issues

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ where ```extras``` can be
7575

7676
## Documentation
7777

78-
See [https://thainlp.org/pythainlp/docs/1.7/](https://thainlp.org/pythainlp/docs/1.7/)
78+
See [https://thainlp.org/pythainlp/docs/2.0/](https://thainlp.org/pythainlp/docs/2.0/)
7979

8080
## License
8181

@@ -161,7 +161,7 @@ $ pip install pythainlp[extra1,extra2,...]
161161

162162
## เอกสารการใช้งาน
163163

164-
อ่านที่ [https://thainlp.org/pythainlp/docs/1.7/](https://thainlp.org/pythainlp/docs/1.7/)
164+
อ่านที่ [https://thainlp.org/pythainlp/docs/2.0/](https://thainlp.org/pythainlp/docs/2.0/)
165165

166166
## สัญญาอนุญาต
167167

setup.py

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,13 +69,22 @@
6969
extras_require=extras,
7070
license="Apache Software License 2.0",
7171
zip_safe=False,
72-
keywords="pythainlp",
72+
keywords=[
73+
"pythainlp",
74+
"NLP",
75+
"natural language processing",
76+
"text analytics",
77+
"ThaiNLP",
78+
],
7379
classifiers=[
7480
"Development Status :: 5 - Production/Stable",
7581
"Programming Language :: Python :: 3",
7682
"Intended Audience :: Developers",
7783
"License :: OSI Approved :: Apache Software License",
7884
"Natural Language :: Thai",
85+
"Topic :: Scientific/Engineering :: Artificial Intelligence",
86+
"Topic :: Text Processing",
87+
"Topic :: Text Processing :: General",
7988
"Topic :: Text Processing :: Linguistic",
8089
],
8190
scripts=['bin/pythainlp']

0 commit comments

Comments
 (0)