.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.4.
.TH NGRAMSHRINK "1" "May 2016" "OpenGrm NGram library 1.3.0" "User Commands"
.SH NAME
ngramshrink \- Shrink ngram model from input model file.
.SH DESCRIPTION
Shrink ngram model from input model file.
.IP
.SH SYNOPSIS
ngramshrink [\-\-options] [in.fst [out.fst]]
.SH OPTIONS
.PP
.HP
\fB\-\-backoff_label\fR: type = int64, default = 0
.IP
Backoff label
.HP
\fB\-\-check_consistency\fR: type = bool, default = false
.IP
Check model consistency
.HP
\fB\-\-context_pattern\fR: type = string, default = ""
.IP
Pattern of contexts to prune
.HP
\fB\-\-count_pattern\fR: type = string, default = ""
.IP
Pattern of counts to prune
.HP
\fB\-\-method\fR: type = string, default = "seymore"
.IP
One of: "context_prune", "count_prune", "relative_entropy", "seymore"
.HP
\fB\-\-norm_eps\fR: type = double, default = 0.001
.IP
Normalization check epsilon
.HP
\fB\-\-shrink_opt\fR: type = int32, default = 0
.IP
Optimization level: Range 0 (fastest) to 2 (most accurate)
.HP
\fB\-\-target_number_of_ngrams\fR: type = int64, default = \fB\-1\fR
.IP
Maximum number of ngrams to leave in model after pruning. Value less than zero means no target number, just use theta.
.HP
\fB\-\-theta\fR: type = double, default = 0
.IP
Pruning threshold theta
.HP
\fB\-\-total_unigram_count\fR: type = double, default = \fB\-1\fR
.IP
Total unigram count
.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.