Command-line

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

Note

We rely on hydra to manage CLI interface and configurations. By default, 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.

Default configuration

The full list of supported keywords is summarized below with the yaml syntax. Keyword arguments can be passed in the command line or as a YAML file.

To see this list in the command line, type:

/$ qumin --help

Keywords at the first level (“Common options” below), such as action, data, etc. can be accessed directly using the syntax keyword=value, eg:

qumin action=pred key=value

Keywords indented under a namespace need to be accessed as namespace.option=value, eg pats.defective=true, or pats.overabundant.keep=true.

For the meaning of each keyword and what values they can take, please refer to the full CLI reference (links below) or to the config module: qumin.config.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
  export:
    html: true
    ctxt: false
    stat: false
    pdf: true
    png: false
  display:
    horizontal: false
    topdown: true
    layout: qumin
macroclasses:
  horizontal: false
  square: false
  topdown: true
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:
    forms: null
    lexemes: null
  importResults: null
  exportApplicable: false
  export_log: false
  token_freq:
    patterns: false
    predictors: false
    overabundant: false
    cells: false

Note

Hydra permits a lot more configuration than what is listed here. 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". For more details, refer to the Hydra documentation or with qumin --hydra-help.

Full CLI reference