commit 567adda7bfaf69a271d9a9d0fd531447d0b7ab2a Author: vivekvardhanadepu Date: Tue Jun 8 14:14:13 2021 +0530 adding installation instructions in README diff --git a/README.md b/README.md index 7115def..352c79b 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,20 @@ # apertium-lexical-training -The procedure for lexical selection training is a bit messy, with various scripts involved that require lots of manual tweaking, and many third party tools to be installed, e.g. irstlm, moses, gizapp. The goal of this task is to make the training procedure as streamlined and user-friendly as possible +The procedure for lexical selection training is a bit messy, with various scripts involved that require lots of manual tweaking, and many third party tools to be installed, e.g. fast_align, yasmet, etc. The goal of this task is to make the training procedure as streamlined and user-friendly as possible for more, read https://wiki.apertium.org/wiki/Ideas_for_Google_Summer_of_Code/User-friendly_lexical_selection_training -## tests +## Requirements +* [parallel corpus](https://wiki.apertium.org/wiki/Corpora) +* [apertium](https://wiki.apertium.org/wiki/Installation) +* [fast_align](https://github.com/clab/fast_align) +* [apertium-lex-tools](https://wiki.apertium.org/wiki/Install_Apertium_core_by_compiling) (with yasmet and scripts) +* [language pair](https://wiki.apertium.org/wiki/List_of_language_pairs) (install locally) + +## Installation steps +* install the requirements and download or clone this repo (`git clone https://github.com/vivekvardhanadepu/apertium-lexical-training.git`) +* provide tools' and corpus' paths in [config.toml](config.toml) (for ref, see [config.toml.example](config.toml.example)) +* run lexical_training.py +## tests This folder contains scripts for automated testing of the helper scripts