NGRAMREAD(1)

📦

version 1.3.17 · 3 versions

✨ NAME ✨

ngramread — bestie, this is the manual page for ngramread 1.3.17 💅

okay so real talk: ngramread takes text formats and transforms them into FSTs. that's the whole vibe. it's giving glow-up-for-your-data ✨

here's the usage, no cap:

Usage: ngramread [--options] [in.txt [out.fst]]

and now, the flags. buckle up, there's a lot, but every single one is here because i would never do you like that 🫶

--ARPA — type = bool, default = false. read the model from ARPA format.
--OOV_symbol — type = std::string, default = "<UNK>". the class label for OOV symbols.
--epsilon_symbol — type = std::string, default = "<epsilon>". the label for epsilon transitions.
--renormalize_arpa — type = bool, default = false. if true, it attempts to renormalize an unnormalized ARPA format model by normalizing the unigram state and recomputing the backoff weights. only used if --ARPA=true, iykyk.
--symbols — type = std::string, default = "". label symbol table.

--help — type = bool, default = false. show usage information.
--helpshort — type = bool, default = false. show brief usage information.
--tmpdir — type = std::string, default = "/tmp". temporary directory.
--v — type = int32_t, default = 0. verbosity level.

--fst_align — type = bool, default = false. write FST data aligned where appropriate.
--fst_default_cache_gc — type = bool, default = true. enable garbage collection of cache.
--fst_default_cache_gc_limit — type = int64_t, default = 1048576. the cache byte size that triggers garbage collection.
--fst_read_mode — type = std::string, default = "read". default file reading mode for mappable files.
--fst_verify_properties — type = bool, default = false. verify FST properties queried by TestProperties.
--save_relabel_ipairs — type = std::string, default = "". save input relabel pairs to file.
--save_relabel_opairs — type = std::string, default = "". save output relabel pairs to file.

--end_symbol — type = std::string, default = "</s>". class label for sentence end.
--start_symbol — type = std::string, default = "<s>". class label for sentence start.

--fst_compat_symbols — type = bool, default = true. require symbol tables to match when appropriate.
--fst_field_separator — type = std::string, default = " ". the set of characters used as a separator between printed fields.

--fst_error_fatal — type = bool, default = true. FST errors are fatal; o.w. return objects flagged as bad: e.g., FSTs: kError property set, FST weights: not a Member().
--ngram_error_fatal — type = bool, default = true. NGram errors are fatal if true; otherwise returns objects flagged as bad: e.g., NGramModel::Error() is true.

--fst_weight_parentheses — type = std::string, default = "". 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).
--fst_weight_separator — type = std::string, default = ",". character separator between printed composite weights; must be a single character.

and that's the whole page, bestie. every flag, every default, every little detail — not me gatekeeping anything 💜

this was ngramread 1.3.17, dated February 2022. periodt. 💅✨

📦 where this page comes from

fedora 44: opengrm-ngram-tools 1.3.17-2.fc44 · Apache-2.0
💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash on 2026-10-13: a language model's rewrite of the original, under its terms