alihan/clean-text-nlp-preprocessing
1
0
Fork 0
mirror of https://github.com/jfilter/clean-text.git synced 2021-09-19 22:32:58 +03:00
Code Issues Projects Releases Wiki Activity

improve README

Browse Source
This commit is contained in:
Johannes Filter
2020-07-24 22:30:14 +02:00
parent 58b269c6b8
commit ffe2b7b205
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@@ -37,6 +37,8 @@ If [unidecode](https://github.com/takluyver/Unidecode) is not available, `clean-
Transliteration to closest ASCII symbols involes manually mappings, i.e., `ê` to `e`. Unidecode's mapping is superiour but unicodedata's are sufficent.
However, you may want to disable this feature altogether depending on your data and use case.
NB: The package is named `clean-text` and not `cleantext`.
## Usage
```python
@@ -72,9 +74,7 @@ So far, only English and German are fully supported. It should work for the majo
## Development
- install [Pipenv](https://pipenv.readthedocs.io/en/latest/)
- get the package: `git clone https://github.com/jfilter/clean-text && cd clean-text && pipenv install`
- run tests: `pipenv run pytest`
[Install and use poetry](https://python-poetry.org/).
## Contributing