.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.4.
.TH NGRAMREAD "1" "May 2016" "OpenGrm NGram library 1.3.0" "User Commands"
.SH NAME
ngramread \- Transform text formats to fst.
.SH DESCRIPTION
Transform text formats to fst.
.IP
.SH SYNOPSIS
ngramread [\-\-options] [in.txt [out.fst]]
.SH OPTIONS
.PP
.HP
\fB\-\-ARPA\fR: type = bool, default = false
.IP
Read model from ARPA format
.HP
\fB\-\-OOV_symbol\fR: type = string, default = "<unk>"
.IP
Class label for OOV symbols
.HP
\fB\-\-epsilon_symbol\fR: type = string, default = "<epsilon>"
.IP
Label for epsilon transitions
.HP
\fB\-\-renormalize_arpa\fR: type = bool, default = false
.IP
If true, attempts to renormalize an unnormalized ARPA format model by normalizing the unigram state and recomputing the backoff weights.  Only used if \fB\-\-ARPA\fR=\fI\,true\/\fR.
.HP
\fB\-\-symbols\fR: type = string, default = ""
.IP
Label symbol table
.PP
.HP
\fB\-\-help\fR: type = bool, default = false
.IP
show usage information
.HP
\fB\-\-helpshort\fR: type = bool, default = false
.IP
show brief usage information
.HP
\fB\-\-tmpdir\fR: type = string, default = "/tmp"
.IP
temporary directory
.HP
\fB\-\-v\fR: type = int32, default = 0
.IP
verbose level
.PP
.HP
\fB\-\-fst_align\fR: type = bool, default = false
.IP
Write FST data aligned where appropriate
.HP
\fB\-\-fst_default_cache_gc\fR: type = bool, default = true
.IP
Enable garbage collection of cache
.HP
\fB\-\-fst_default_cache_gc_limit\fR: type = int64, default = 1048576
.IP
Cache byte size that triggers garbage collection
.HP
\fB\-\-fst_read_mode\fR: type = string, default = "read"
.IP
Default file reading mode for mappable files
.HP
\fB\-\-fst_verify_properties\fR: type = bool, default = false
.IP
Verify fst properties queried by TestProperties
.HP
\fB\-\-fst_weight_parentheses\fR: type = string, default = ""
.IP
Characters enclosing the first weight of a printed composite weight (e.g. pair weight, tuple weight and derived classes) to ensure proper I/O of nested composite weights; must have size 0 (none) or 2 (open and close parenthesis)
.HP
\fB\-\-fst_weight_separator\fR: type = string, default = ","
.IP
Character separator between printed composite weights; must be a single character
.HP
\fB\-\-save_relabel_ipairs\fR: type = string, default = ""
.IP
Save input relabel pairs to file
.HP
\fB\-\-save_relabel_opairs\fR: type = string, default = ""
.IP
Save output relabel pairs to file
.PP
.HP
\fB\-\-end_symbol\fR: type = string, default = "</s>"
.IP
Class label for sentence start
.HP
\fB\-\-start_symbol\fR: type = string, default = "<s>"
.IP
Class label for sentence start
.PP
.HP
\fB\-\-fst_compat_symbols\fR: type = bool, default = true
.IP
Require symbol tables to match when appropriate
.HP
\fB\-\-fst_field_separator\fR: type = string, default = "      "
.IP
Set of characters used as a separator between printed fields
.PP
.HP
\fB\-\-fst_error_fatal\fR: type = bool, default = true
.IP
.TP
FST errors are fatal; o.w. return objects flagged as bad:
e.g., FSTs \- kError prop. true, FST weights \- not  a Member()
.HP
\fB\-\-ngram_error_fatal\fR: type = bool, default = true
.IP
.TP
NGram errors are fatal; o.w. return objects flagged as bad:
e.g., NGramModel::Error() returns true.