diff options
| author | ZJaume <jzaragoza@prompsit.com> | 2022-02-17 17:14:40 +0300 |
|---|---|---|
| committer | ZJaume <jzaragoza@prompsit.com> | 2022-02-17 17:14:40 +0300 |
| commit | a687cfbbd8a8971c2f148738a4c47f5d22f7a098 (patch) | |
| tree | 2a60a0f574668bf76758e00b2cc2d9f5d857c947 | |
| parent | 75bf598b590273938b47b11ccfc88e9254833a62 (diff) | |
Update README and CHANGELOG
| -rw-r--r-- | CHANGELOG.md | 5 | ||||
| -rw-r--r-- | README.md | 13 |
2 files changed, 18 insertions, 0 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md index f79c6bd..5702013 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,9 @@ Unreleased: +* Update to Hardrules 2.0 + * Rules can be parametrized with `--rules_config config.yaml` + * Some rules have been refactored with better names. + * `--run_all_rules` mode to run each rule instead of stoppping at first discard + * Language identification with [FastSpell](https://github.com/mbanon/fastspell) * Huge memory improvements during training. * Hide Tensorflow and Transformers logging messages in executable scripts. * Update HF Transformers, no longer needed single GPU for prediction. @@ -38,6 +38,19 @@ cmake .. -DKENLM_MAX_ORDER=7 -DCMAKE_INSTALL_PREFIX:PATH=/your/prefix/path make -j all install ``` +Hardrules uses [FastSpell](https://github.com/mbanon/fastspell) that requires `python-dev` and `libhunspell-dev`: +```bash +sudo apt install python-dev libhunspell-dev +``` + +Also note that Hunspell language packages must be installed by hand if you are going to work with one of languages listed as [similar](https://github.com/mbanon/fastspell/blob/main/fastspell/config/similar.yaml), i.e.: +``` +sudo apt-get install hunspell-es +``` +or downloaded from an external source, such as https://github.com/wooorm/dictionaries/tree/main/dictionaries + +You can also provide the path to the Hunspell dictionaries directories by using the dictpath atribute in `{/YOUR/INSTALLATION/PATH}/config/hunspell.yaml` (for example, `venv/lib/python3.7/site-packages/fastspell/config/hunspell.yaml` ) if you are installing from PyPI or with `setup.py`, or in `/config/hunspell.yaml` if you are running directly the code. Default path is `/usr/share/hunspell`. + The remaining extra modules required by Bicleaner AI will be automatically downloaded and installed/upgraded (if required) with the first command. After installation, three binary files (`bicleaner-ai-train`, `bicleaner-ai-classify` and `bicleaner-ai-classify-lite`) will be located in your `python/installation/prefix/bin` directory. This is usually `$HOME/.local/bin` or `/usr/local/bin/`. |