Command-line

This section documents in detail Qumin’s command-line actions, or scripts and the related options.

Note

We now rely on hydra to manage CLI interface and configurations. Hydra will create a folder outputs/<yyyy-mm-dd>/<hh-mm-ss>/ containing all results. A subfolder outputs/<yyyy-mm-dd>/<hh-mm-ss>/.hydra/ contains details of the configuration as it was when the script was run. Hydra permits a lot more configuration. For example, any of the following scripts can accept a verbose argument of the form hydra.verbose=Qumin, and the output directory can be customized with hydra.run.dir="./path/to/output/dir".

More details on configuration::

/$ qumin --help

• Common options
• Lattices
  • Full reference
    • LatticeConfig
• Macroclasses
• Microclasses
• Patterns
  • Patterns kinds
  • Full reference
• Predictability heatmaps
  • Full reference
    • HeatmapConfig
• Predictability
  • Full reference

Default configuration

The full list of supported keywords is summarized below with the yaml syntax. Keyword arguments can be passed in the command line: namespace.keyword=value or as a YAML file. For the technical details, refer to the Hydra documentation or to the examples given in the documentation.

For the meaning of each keyword, please refer to the relevant documentation (links above) or to the config module: qumin.utils.config

action: patterns
data: ???
patterns: null
pos: null
lexemes: null
cells: null
sample_lexemes: null
sample_cells: null
force_random: false
seed: 1
force: false
cpus: 1
resegment: false
checkSegments: true
pats:
  kind: phon
  defective: false
  gap_proportion: 0.4
  optim_mem: false
  overabundant:
    keep: false
    freq: true
    tags: null
lattice:
  shorten: false
  aoc: false
  html: false
  ctxt: false
  stat: false
  pdf: true
  png: false
heatmap:
  label: null
  cmap: null
  exhaustive_labels: false
  dense: false
  annotate: false
  order: null
  cols: null
  display:
    n_pairs: true
    freq_margins: true
pred:
  vis: true
  'n':
  - 1
  features: null
  importResults: null
  token_freq:
    patterns: false
    predictors: false
    overabundant: false
    cells: false
entropy: ${oc.deprecated:pred}