MetriCal Command: Validate

Usage

Validate - CLI Example

metrical validate [OPTIONS] [MANIFEST_PATH] --workspace [WORKSPACE]

Purpose

This command validates a MetriCal manifest file located at the specified MANIFEST_PATH, but doesn't actually run the process described in the manifest. This is useful for checking that your manifest is correctly configured before executing potentially time-consuming calibration tasks. The validation process checks for issues such as missing dependencies, incorrect configurations, and cyclic dependencies between stages.

Examples

Validate a MetriCal manifest located in the specified directory.

metrical validate /path/to/directory/<manifest_name>.toml

Arguments

[MANIFEST_PATH]

The path to the TOML manifest.

Options

Global Arguments

As with every command, all global arguments are supported (though not all may be used).

--workspace [WORKSPACE]

The output directory for the final results. By default, if no workspace is provided, the workspace defined in the manifest file will be used.

Results are stored in subdirectories per step. For example, if the output directory is ./output, and there are steps named init and calibrate, then results will be stored in ./output/init and ./output/calibrate.

--set [OVERRIDE_VARIABLES]

Override variables in the manifest.

Say we have a variable named data-to-run:

[project.variables.data-to-run]
description = "The dataset to use for this run"
value = "default_dataset.mcap"

However, we don't want to use default_dataset.mcap for this next run; we have another dataset, better_dataset.mcap, that would work better.

MetriCal makes this easy with the --set option. You can overwrite this default value from the command line like so: --set data-to-run:better_dataset.mcap. Now, MetriCal will use this new value for the run instead of the default.