wandb artifact-put

Upload an artifact to W&B.

Upload a file, directory, or URL reference as a versioned artifact. The PATH can be a local file, a local directory, or a URL (containing ://) to log as a reference artifact.

If --name is not specified, the artifact name defaults to the basename of the path. If the project cannot be parsed from the name, you are prompted to enter one.

Examples:

Upload a directory as a dataset artifact

wandb artifact put ./project/artifact_name --type dataset

Upload a file with a specific name and type

wandb artifact put --name project/artifact_name --type model ./model.pt

Upload with multiple aliases (latest and v1.0 in this example)

wandb artifact put --alias latest --alias v1.0 ./project/artifact_name

Log a URL as a reference artifact

wandb artifact put --type dataset s3://my-bucket/data

Usage

wandb artifact put [OPTIONS] PATH

Options

name

format. Defaults to the basename of the path.

Flag	Default	Type
-n, --name	None	STRING

description

A description of this artifact.

Flag	Default	Type
-d, --description	None	STRING

type

The type of the artifact. Defaults to ‘dataset’.

Flag	Default	Type
-t, --type	dataset	STRING

alias

An alias to apply to this artifact. Can be specified multiple times. Defaults to ‘latest’.

Flag	Default	Type
-a, --alias	[‘latest’]	STRING

run_id

Upload to an existing run with this ID.

Flag	Default	Type
--id	None	STRING

resume

Resume the last run from your current directory.

Flag	Default	Type
--resume	None	BOOL

skip_cache

Skip caching while uploading artifact files.

Flag	Default	Type
--skip_cache	False	BOOL

policy

Set the storage policy for artifact files. Either ‘mutable’ (default) or ‘immutable’.

Flag	Default	Type
--policy	mutable	Choice([‘mutable’, ‘immutable’])

help

Show this message and exit.

Flag	Default	Type
--help	False	BOOL

CLI Help

Usage: artifact put [OPTIONS] PATH

  Upload an artifact to W&B.

  Upload a file, directory, or URL reference as a versioned artifact. The PATH
  can be a local file, a local directory, or a URL (containing `://`) to log
  as a reference artifact.

  If `--name` is not specified, the artifact name defaults to the basename of
  the path. If the project cannot be parsed from the name, you are prompted to
  enter one.

  Examples:

  Upload a directory as a dataset artifact

  ```bash wandb artifact put ./project/artifact_name --type dataset ```

  Upload a file with a specific name and type

  ```bash wandb artifact put --name project/artifact_name --type model
  ./model.pt ```

  Upload with multiple aliases (`latest` and `v1.0` in this example)

  ```bash wandb artifact put --alias latest --alias v1.0
  ./project/artifact_name ```

  Log a URL as a reference artifact

  ```bash wandb artifact put --type dataset s3://my-bucket/data ```

Options:
  -n, --name TEXT               Artifact name in `project/artifact_name`
                                format. Defaults to the basename of the path.
  -d, --description TEXT        A description of this artifact.
  -t, --type TEXT               The type of the artifact. Defaults to
                                'dataset'.
  -a, --alias TEXT              An alias to apply to this artifact. Can be
                                specified multiple times. Defaults to
                                'latest'.
  --id TEXT                     Upload to an existing run with this ID.
  --resume                      Resume the last run from your current
                                directory.
  --skip_cache                  Skip caching while uploading artifact files.
  --policy [mutable|immutable]  Set the storage policy for artifact files.
                                Either 'mutable' (default) or 'immutable'.
  --help                        Show this message and exit.