-
Notifications
You must be signed in to change notification settings - Fork 4
API Reference
On this page one can find the API references of the latest version of master branch.
API references of all versions of master branch are also available below:
API references of latest version on our other branches, including develop branch are available below. Please note that due to the fact that this project is still in development, APIs of versions below may change and it may take time for the API references to be updated accordingly.
-
V0.5a feat/export-model: The API reference for this branch will not be released separately. It's difference with master branch is that it added the function of loading and saving trained models, which can be checked out by
> python aligner.py -h. The model of this branch is of model API version 0.4a, which is available here.
- support for models v0.3a
Run
> python aligner.py -h
To see all options.
A sample config file is provided in src\sample_config_file.ini.
The purpose of a config file is to provide information regarding specific testing and training data, instead of having to type all the options on the console.
The config file is divided into 3 sections: General, TrainData, and TestData.
[General]
DataDirectory = ~/Data/
TargetLanguageSuffix = cn
SourceLanguageSuffix = en
[TrainData]
TextFilePrefix = train
TagFilePrefix = train.tags
AlignmentFileSuffix = wa
[TestData]
TextFilePrefix = test
TagFilePrefix = test.tags
Reference = FULLPATHTOFILE.WA
The aligner will search for files that matches the prefix and suffix given above in the DataDirectory. Please note that currently Reference has to be the full path.
The descriptions of file formats supported by this version are here.