NGRAMAPPLY(1)

🌸 NAME 🌸

ngramapply — bestie, this is the manual page for ngramapply, version 1.3.17. That's the whole name section, short and sweet, we move 💅

---

✨ DESCRIPTION ✨

okay so here's the tea: ngramapply intersects an n-gram model with an FST archive. That's the entire mission statement and honestly? she ate. 🔥

The usage goes a little something like this:

Usage: ngramapply [--options] ngram.fst [in.far [out.far]]

So you hand her an ngram.fst, and optionally an in.far and an out.far, and she does her lil thing. 🫶

---

🚀 PROGRAM FLAGS 🚀

• --bo_arc_type — type = std::string, default = "phi". Has to be one of: "phi" (that's the default, btw), "epsilon", or "lexicographic". Pick your fighter 👑

---

📚 LIBRARY FLAGS 📚

🌈 Flags from: compile-strings.cc

• --far_field_separator — the set of characters used as a separator between printed fields. type = std::string, and the default is, no joke, printed on the page exactly like this:

--far_field_separator: type = std::string, default = "
              "

that's a quote, a line break, some spaces, and a closing quote — we report it, we don't question it 💀

🌟 Flags from: flags.cc

• --help — type = bool, default = false. Show usage information ✨
• --helpshort — type = bool, default = false. Show brief usage information (the tl;dr version, we stan)
• --tmpdir — type = std::string, default = "/tmp". Temporary directory 📁
• --v — type = int32_t, default = 0. Verbosity level — crank it up if you want the yapping

🦋 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 🗑️ (she cleans up after herself, iconic)
• --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()
• --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!! 💖 this lil beauty is ngramapply version 1.3.17, dated February 2022 — go forth and intersect your n-grams, ily, mwah 🧚‍♀️🎀