Skip to content

API Reference

Jetic Gu edited this page Jun 23, 2017 · 27 revisions

Introduction

On this page one can find the API references of the latest version of master branch.

API reference(master) V0.3a

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.

  • Nothing

Current Version (V0.3a)

Changes (Comparing to 0.2a)

  • added config files to main programme. Everything else is the same.

Options

Run

> python aligner.py -h

To see all options.

Config file

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.

Dataset formats

The descriptions of file formats supported by this version are here.

Individual modules