systemslab artifact upload

Description	Upload an artifact.
Usage	systemslab artifact upload [OPTIONS] <FILE>

Description

The systemslab artifact upload command allows you to upload an artifact and attach it to an existing job, experiment, context, or context-experiment.

Attaching artifacts to entities

All SystemsLab artifacts must be attached to an existing SystemsLab entity. To specify what the artifact should be attached to, use the --context, --experiment, --job, and --run flags.

The valid combinations of these flags are:

• systemslab artifact upload --job <job> --run <run>
  Upload an artifact for a single run in a job.
• systemslab artifact upload --experiment <experiment>
  Upload an artifact for an experiment.
• systemslab artifact upload --context <context>
  Upload an artifact for a context.
• systemslab artifact upload --experiment <experiment> --context <context>
  Upload an artifact to an experiment attached to a context. Note that this does not upload the artifact to either of the context or the experiment but rather to the edge between them.

Overriding existing artifacts

In SystemsLab, artifacts are uniquely identified by the entity to which they are attached in combination with their name and type. Attempting to upload an artifact with the same entity, name, and type as another will overwrite the previous artiact.

Options

Option	Default	Description
<FILE>		The file to upload as the artifact.
-t, --tag		Tags to add to the artifact. This flag can be specified multiple times to add more flags.
--name	The basename of the file to be uploaded.	Set the name of the uploaded artifact.
--type	user	The type of the artifact to upload. Artifacts with different types effectively live in different namespaces. Generally, user artifacts should be uploaded with the user type.
--context		The context ID to attach this artifact to.
--experiment		The experiment ID to attach this artifact to.
--job		The job ID to attach this artifact to. Requires --run to be passed as well.
--run		The run index to attach this artifact to. Requires --job to be passed as well.

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.