Skip to content

systemslab workspace facet ​

Description List, declare and remove the facets a workspace groups its contexts by.
Usage systemslab workspace facet <WORKSPACE> list [-H]
systemslab workspace facet <WORKSPACE> add <KEY> [--from-param | --from-label] [--position <N>]
systemslab workspace facet <WORKSPACE> remove <KEY>

Description ​

A facet is a key, such as phase or allocator, that a workspace groups and filters its contexts by. A facet's values come either from labels set by hand on each context with systemslab workspace label, or, for a facet added with --from-param, from the experiment parameter of the same name, in which case a context has every value its experiments use.

add declares a facet, or changes an existing one. Without --from-param or --from-label an existing facet keeps its source. Adding an existing label facet with --from-param discards its labels, and adding a parameter facet with --from-label switches it back to labels. remove removes a facet along with every label set for it.

systemslab workspace facet allocator-sweep add phase
systemslab workspace facet allocator-sweep add allocator --from-param
systemslab workspace facet allocator-sweep add allocator --from-label

Options ​

OptionDefaultDescription
<WORKSPACE>The workspace's slug or id.
<KEY>The facet's key.
--from-param(add) Take the facet's values from the experiment parameter with the same name instead of from labels.
--from-label(add) Take the facet's values from labels. This is the default for a new facet; use it to switch a parameter facet back to labels.
--position <N>(add) Where to show the facet. Facets are shown in ascending order of position, then by key.
-H, --no-header(list) Don't print the table header.

Common Options ​

OptionDefaultDescription
--systemslab-url The URL at which to access the systemslab server.
--colorauto Controls when color is used in the output. Possible values are auto, always, and never.
--output-formatlong 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 ​

VariableDescription
SYSTEMSLAB_URLSpecify the URL used to contact the SystemsLab server. Equivalent to --systemslab-url.