NGRAMMARGINALIZE(1)

👑 NAME 👑

ngrammarginalize — the manual page for ngrammarginalize 1.3.17, bestie. Yes it's a whole command, yes it's iconic, let's go 💅

---

✨ DESCRIPTION ✨

Okay so the entire serve here is: it marginalizes an n-gram model, and it pulls that model straight out of the input model file. That's the job. That's the assignment. Periodt. 🦋

Usage: ngrammarginalize [--options] [in.fst [out.fst]]

---

🌸 PROGRAM FLAGS 🌸

These are the flags that belong to the program itself, the main character energy flags, if you will 🔥

• --backoff_label — type = int64_t, default = 0. This is the backoff label, bestie.
• --check_consistency — type = bool, default = false. Check the model's consistency. vibe check the whole model fr fr.
• --max_bo_updates — type = int32_t, default = 10. Max iterations of backoff re-calculation.
• --norm_eps — type = double, default = 0.001. Normalization check epsilon.

---

📚 LIBRARY FLAGS 📚

🎀 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". The 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 cache.
• --fst_default_cache_gc_limit — type = int64_t, default = 1048576. 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.

🎀 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(). So like, either everything dies dramatically or you get back something marked as bad. Pick your fighter 💀
• --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.

---

And that's the whole page, bestie!! 🫶 ngrammarginalize 1.3.17, February 2022 — go forth and marginalize those n-grams, you absolute icon 💜