CLI Reference#

This page provides documentation for our command line tools.

caveat#

Console script for caveat.

Usage:

caveat [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--version`	boolean	Show the version and exit.	`False`
`--help`	boolean	Show this message and exit.	`False`

caveat batch#

Train and report on a batch of encoders and models as per the given configuration file.

Usage:

caveat batch [OPTIONS] CONFIG_PATH

Options:

Name	Type	Description	Default
`--test`, `-t`	boolean	N/A	`False`
`--no-gen`, `-ng`	boolean	N/A	`False`
`--no-infer`, `-ni`	boolean	N/A	`False`
`--stats`, `-s`	boolean	N/A	`False`
`--verbose`, `-v`	boolean	N/A	`False`
`--help`	boolean	Show this message and exit.	`False`

caveat eval#

Evaluate on the given observed population and logs directory.

Usage:

caveat eval [OPTIONS] CONFIG_PATH

Options:

Name	Type	Description	Default
`--schedules`	text	N/A	`synthetic_schedules.csv`
`--labels`	text	N/A	`Sentinel.UNSET`
`--verbose`, `-v`	boolean	N/A	`False`
`--stats`	boolean	N/A	`False`
`--nrun`, `-n`	boolean	Evaluate an nrun directory.	`False`
`--batch`, `-b`	boolean	Evaluate a batch of models.	`False`
`--help`	boolean	Show this message and exit.	`False`

caveat jbatch#

Train and report on a batch of joint models as per the given configuration file.

Usage:

caveat jbatch [OPTIONS] CONFIG_PATH

Options:

Name	Type	Description	Default
`--test`, `-t`	boolean	N/A	`False`
`--no-infer`, `-ni`	boolean	N/A	`False`
`--no-gen`, `-ng`	boolean	N/A	`False`
`--verbose`, `-v`	boolean	N/A	`False`
`--no_sample`, `-ns`	boolean	N/A	`False`
`--patience`, `-p`	integer	N/A	`8`
`--help`	boolean	Show this message and exit.	`False`

caveat jrun#

Train and report on a joint model as per the given configuration file.

Usage:

caveat jrun [OPTIONS] CONFIG_PATH

Options:

Name	Type	Description	Default
`--test`, `-t`	boolean	N/A	`False`
`--no-infer`, `-ni`	boolean	N/A	`False`
`--no-gen`, `-ng`	boolean	N/A	`False`
`--verbose`, `-v`	boolean	N/A	`False`
`--no_sample`, `-ns`	boolean	N/A	`False`
`--patience`, `-p`	integer	N/A	`8`
`--help`	boolean	Show this message and exit.	`False`

caveat lrun#

Train and test label predicting model.

Usage:

caveat lrun [OPTIONS] CONFIG_PATH

Options:

Name	Type	Description	Default
`--verbose`, `-v`	boolean	N/A	`False`
`--help`	boolean	Show this message and exit.	`False`

caveat mmrun#

Multi-model variation of run command for brute-force conditionality.

Usage:

caveat mmrun [OPTIONS] CONFIG_PATH

Options:

Name	Type	Description	Default
`--test`, `-t`	boolean	N/A	`False`
`--no-infer`, `-ni`	boolean	N/A	`False`
`--no-gen`, `-ng`	boolean	N/A	`False`
`--verbose`, `-v`	boolean	N/A	`False`
`--cool-start`, `-cs`	boolean	N/A	`False`
`--help`	boolean	Show this message and exit.	`False`

caveat ngen#

Train and report variance on n identical runs with varying seeds.

Usage:

caveat ngen [OPTIONS] CONFIG_PATH

Options:

Name	Type	Description	Default
`--n`	integer	N/A	`5`
`--no-infer`, `-ni`	boolean	N/A	`False`
`--stats`, `-s`	boolean	N/A	`False`
`--verbose`, `-v`	boolean	N/A	`False`
`--help`	boolean	Show this message and exit.	`False`

caveat nrun#

Train and report variance on n identical runs with varying seeds.

Usage:

caveat nrun [OPTIONS] CONFIG_PATH

Options:

Name	Type	Description	Default
`--n`	integer	N/A	`5`
`--test`, `-t`	boolean	N/A	`False`
`--no-gen`, `-ng`	boolean	N/A	`False`
`--no-infer`, `-ni`	boolean	N/A	`False`
`--stats`, `-s`	boolean	N/A	`False`
`--verbose`, `-v`	boolean	N/A	`False`
`--help`	boolean	Show this message and exit.	`False`

caveat report#

Report on the given observed population and logs directory.

Usage:

caveat report [OPTIONS] OBSERVED_PATH LOGS_DIR

Options:

Name	Type	Description	Default
`--name`	text	N/A	`synthetic_schedules.csv`
`--verbose`	boolean	N/A	`False`
`--head`	integer	N/A	`10`
`--batch`, `-b`	boolean	N/A	`False`
`--help`	boolean	Show this message and exit.	`False`

caveat run#

Train and report on an encoder and model as per the given configuration file.

Usage:

caveat run [OPTIONS] CONFIG_PATH

Options:

Name	Type	Description	Default
`--test`, `-t`	boolean	N/A	`False`
`--no-infer`, `-ni`	boolean	N/A	`False`
`--no-gen`, `-ng`	boolean	N/A	`False`
`--verbose`, `-v`	boolean	N/A	`False`
`--help`	boolean	Show this message and exit.	`False`

caveat tune#

Train and report on an encoder and model as per the given configuration file.

Usage:

caveat tune [OPTIONS] CONFIG_PATH

Options:

Name	Type	Description	Default
`--db-path`, `-db`	path	N/A	`Sentinel.UNSET`
`--test`, `-t`	boolean	N/A	`False`
`--no-infer`, `-ni`	boolean	N/A	`False`
`--no-gen`, `-ng`	boolean	N/A	`False`
`--verbose`, `-v`	boolean	N/A	`False`
`--help`	boolean	Show this message and exit.	`False`