Appearance
summary import experiment
| Description | Import rezolus metrics to view them as a SystemsLab experiment. |
|---|---|
| Usage | systemslab import rezolus [OPTIONS] <METRICS> |
Description
The systemslab import rezolus command imports a recording made by rezolus record so that it can be viewed within systemslab. This allows you to use systemslab's reports to view the metrics contained within the recording.
Three recording formats are accepted: a .dendro archive (what rezolus 6.0 writes by default), a .rez archive, and a .parquet file. The format is read from the file's contents, not its name. An archive must hold exactly one recording.
Options
| Option | Default | Description |
|---|---|---|
<METRICS> | The path to the recording to import: a `.dendro`, `.rez` or `.parquet` file. | |
--name <NAME> | The name to give the resulting experiment. | |
--no-context | Do not create a context for the experiment. | |
--postprocessing-config | None | Provide a custom postprocessing configuration. If not provided, either the config submitted during experiment creation or the default configuration is used. The config file is a TOML file and can override individual parameters in the original config. |
--workspace <WORKSPACE> | Add the new context to this workspace, given by its slug or id. Repeat the flag to add it to several workspaces. Defaults to SYSTEMSLAB_WORKSPACE, or else the workspace config option. An unknown workspace is an error, and nothing is created. Has no effect with --context or --no-context. | |
--no-workspace | Don't add the new context to the default workspace. | |
--label <KEY=VALUE> | Label the new context in each workspace it is added to. Repeat the flag to set several labels. Each key must already be a label facet of the workspace (see systemslab workspace facet), or nothing is created. Can't be combined with --context or --no-context. |
Common Options
| Option | Default | Description |
|---|---|---|
--systemslab-url | The URL at which to access the systemslab server. | |
--color | auto | Controls when color is used in the output. Possible values are auto, always, and never. |
--output-format | long | Output format to use when outputting messages. long will result output designed to be human-readable while short is short output meant to be used within scripts. |
Environment Variables
| Variable | Description |
|---|---|
SYSTEMSLAB_URL | Specify the URL used to contact the SystemsLab server. Equivalent to --systemslab-url. |
SYSTEMSLAB_WORKSPACE | The workspace new contexts are added to by default. Overridden by --workspace. |