NGRAMMAKE(1)

✨ NAME ✨

okay bestie, meet ngrammake — it's the User Commands girlie whose manual page you're reading rn, and she's serving version 1.3.17 💅

---

🌸 DESCRIPTION 🌸

She makes an n-gram model out of an input count file. That's the whole vibe. That's her job. And she eats every time. 🍓

Usage, copy it exactly bestie:

ngrammake [--options] [in.fst [out.fst]]

---

🦋 PROGRAM FLAGS 🦋

these are her flags, the ones that actually change what kind of model you get. read them. love them. 💖

• --backoff — type = bool, default = false. Turn on backoff smoothing. (Default is method dependent, so like… it depends on your method, iykyk.)
• --backoff_label — type = int64_t, default = 0. The backoff label. that's it, that's the flag. 👑
• --bins — type = int64_t, default = -1. How many bins for katz or absolute discounting.
• --check_consistency — type = bool, default = false. Check that your model is consistent. vibe check for your model, fr.
• --count_of_counts — type = std::string, default = "". Read the count-of-counts from a file.
• --discount_D — type = double, default = -1. The absolute discount value D to use.
• --interpolate — type = bool, default = false. Use interpolated smoothing. (Default is method dependent again, bestie, she keeps it mysterious.)
• --method — type = std::string, default = "katz". One of: "absolute", "katz", "kneser_ney", "presmoothed", "unsmoothed", "katz_frac", "witten_bell". pick your fighter 💅
• --norm_eps — type = double, default = 0.001. The normalization check epsilon.
• --witten_bell_k — type = double, default = 1. The Witten-Bell hyperparameter K.

---

🌈 LIBRARY FLAGS 🌈

these ones come from the library itself, not from the main program. still iconic, still matters. 🫶

⭐ Flags from: flags.cc

• --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.

⭐ Flags from: fst.cc

• --fst_align — type = bool, default = false. Write FST data aligned where appropriate.
• --fst_default_cache_gc — type = bool, default = true. Enable garbage collection of the cache. (yes bestie, it's on by default, she's tidy.)
• --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 a file.
• --save_relabel_opairs — type = std::string, default = "". Save output relabel pairs to a file.

⭐ Flags from: ngram-output.cc

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

⭐ Flags from: symbol-table.cc

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

⭐ Flags from: util.cc

• --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.

⭐ Flags from: weight.cc

• --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.

no cap on the last two: those size rules are real and she will be dramatic about it. --fst_weight_parentheses has to be size 0 or 2, and --fst_weight_separator has to be exactly one character. periodt. 🎀

---

and that's the whole page, bestie!! go make some n-grams and slay 💜

ngrammake version 1.3.17, dated February 2022 — that's the source and the date, signed off with a 🦋 and a little curtsy. bye pookie!! ✨