Usage: polyaxon artifacts [OPTIONS] COMMAND [ARGS]...
Commands for managing artifact versions.
Options:
-p, --project TEXT The project name, e.g. 'mnist' or 'acme/mnist'.
-ver, --version TEXT The artifact version, e.g. 'v1.3.4' or 'rc1' or
'latest'.--help Show this message and exit.
Commands:
copy Copy an artifact version.
dashboard Open this artifact version's dashboard details in browser.
delete Delete a artifact version.
get Get info for an artifact version by name.
ls List artifact versions by owner or owner/artifact.
pull Package and download an artifact version or many artifact...
push Push local packaged artifact version or multiple artifact...
register Register a new artifact version.
stage Update stage for a artifact version.
stages List stages information for an artifact version by name,...
transfer Transfer the version to a destination project under the same...
update Update artifact version.
artifacts ls
Usage: polyaxon artifacts ls[OPTIONS]
List artifact versions by owner or owner/artifact.
Examples:
$ polyaxon artifacts ls-p project
$ polyaxon artifacts ls--project=acme/data-versioning
Options:
-p, --project TEXT The project name, e.g. 'mnist' or 'acme/mnist'.
-q, --query TEXT To filter the artifact versions based on this query
spec.
-s, --sort TEXT To order the artifact versions based on the sort spec.
--limit INTEGER To limit the list of artifact versions.
--offset INTEGER To offset the list of artifact versions.
--help Show this message and exit.
artifacts register
Usage: polyaxon artifacts register [OPTIONS]
Register a new artifact version. If the name corresponds to an existing
artifact version, it will raise an error or it will update the version if`--force` is provided.
Examples:
$ polyaxon artifacts register --version=version-name --connection=dataset-gcs --run-uid=uuid
$ polyaxon artifacts register --project=images-dataset --connection=dataset-gcs --description="..."
$ polyaxon artifacts register -p images-dataset --content='{"foo": "bar"}'-ver latest --run-uid=uuid --artifacts=lin1,lin2
$ polyaxon artifacts register -p owner/name -ver v1 --tags="tag1,tag2"
Options:
-p, --project TEXT The project name, e.g. 'mnist' or 'acme/mnist'.
-ver, --version TEXT The artifact version, e.g. 'v1.3.4' or 'rc1' or
'latest'.--description TEXT Description of the version.
--tags TEXT Tags of the version (comma separated values).
--content TEXT Additional content/metadata (Json object) to save with
the artifact version.
--run-uid TEXT The run to promote as a artifact version.
--artifacts TEXT The artifacts to link to this artifact version.
--connection TEXT The connection to link to this artifact version.
--force Flag to force register if the version already exists.
--help Show this message and exit.
artifacts copy
Usage: polyaxon artifacts copy [OPTIONS]
Copy an artifact version. If the name corresponds to an existing artifact
version, it will raise an error or it will update the version if`--force`
is provided.
Examples:
$ polyaxon artifacts copy --version=version-name --to-project dest-project
$ polyaxon artifacts copy --project=images-dataset -to dest-project --force
$ polyaxon artifacts copy -p images-dataset --content='{"foo": "bar"}'-ver latest
$ polyaxon artifacts copy -p owner/name -ver v1 --tags="tag1,tag2"--name new-v1
Options:
-p, --project TEXT The project name, e.g. 'mnist' or 'acme/mnist'.
-ver, --version TEXT The artifact version, e.g. 'v1.3.4' or 'rc1' or
'latest'.
-to, --to-project TEXT The project to transfer the version to.
-n, --name TEXT Name of the artifact version, must be unique within
the same project.
--description TEXT Optional new description of the version.
--tags TEXT Optional new tags of the version (comma separated
values).
--content TEXT Optional new content/metadata (Json object) to save
with the artifact version.
--force Flag to force copy if the version already exists.
--help Show this message and exit.
artifacts get
Usage: polyaxon artifacts get [OPTIONS]
Get info for an artifact version by name.
Examples:
To get a default artifact version:
$ polyaxon artifacts get -p data-versioning
To get by specific owner/name
$ polyaxon artifacts get -p owner/data-versioning -ver rc1
Options:
-p, --project TEXT The project name, e.g. 'mnist' or 'acme/mnist'.
-ver, --version TEXT The artifact version, e.g. 'v1.3.4' or 'rc1' or
'latest'.--help Show this message and exit.
artifacts stages
Usage: polyaxon artifacts stages [OPTIONS]
List stages information for an artifact version by name, name & version,
owner/name & tag.
Examples:
$ polyaxon artifacts stages // returns `latest`in current project
$ polyaxon artifacts stages --project=my-project --version=test-version
$ polyaxon artifacts stages -p owner/my-project -ver rc12
Options:
-p, --project TEXT The project name, e.g. 'mnist' or 'acme/mnist'.
-ver, --version TEXT The artifact version, e.g. 'v1.3.4' or 'rc1' or
'latest'.--help Show this message and exit.
artifacts delete
Usage: polyaxon artifacts delete [OPTIONS]
Delete a artifact version. $ polyaxon artifacts delete // delete `latest`in current project
$ polyaxon artifacts delete --project=my-project --version=test-version
$ polyaxon artifacts get -p owner/my-project -ver rc12
Options:
-p, --project TEXT The project name, e.g. 'mnist' or 'acme/mnist'.
-ver, --version TEXT The artifact version, e.g. 'v1.3.4' or 'rc1' or
'latest'.
-y, --yes Automatic yes to prompts. Assume "yes" as answer to
all prompts and run non-interactively.
--help Show this message and exit.
artifacts update
Usage: polyaxon artifacts update [OPTIONS]
Update artifact version.
Uses /docs/core/cli/#caching
Examples:
$ polyaxon artifacts update --version=foobar --description="..."
$ polyaxon artifacts update -p mike1/foobar -ver current-name --name=new-name
$ polyaxon artifacts update --tags="foo, bar"
Options:
-p, --project TEXT The project name, e.g. 'mnist' or 'acme/mnist'.
-ver, --version TEXT The artifact version, e.g. 'v1.3.4' or 'rc1' or
'latest'.
-n, --name TEXT Name of the artifact version, must be unique within
the same project.
--description TEXT Description of the artifact version.
--tags TEXT Tags of the artifact version (comma separated values).
--help Show this message and exit.
artifacts stage
Usage: polyaxon artifacts stage [OPTIONS]
Update stage for a artifact version.
Uses /docs/core/cli/#caching
Examples:
$ polyaxon artifacts stage -ver rc12 -to production
$ polyaxon artifacts stage -p acme/foobar -ver rc12 --to=staging --reason GithubAction --message="Use carefully!"
Options:
-p, --project TEXT The project name, e.g. 'mnist' or
'acme/mnist'.
-ver, --version TEXT The artifact version, e.g. 'v1.3.4' or 'rc1'
or 'latest'.
-to, --to[testing|staging|production|disabled]
Stage to transition to.
--reason TEXT Reason or service to set with this stage
change. Default: UserStageUpdate, e.g.
CustomAlertTrigger.
--message TEXT Additional information to set with this
stage change.
--help Show this message and exit.
artifacts transfer
Usage: polyaxon artifacts transfer [OPTIONS]
Transfer the version to a destination project under the same
owner/organization.
Uses /docs/core/cli/#caching
Examples:
$ polyaxon artifacts transfer -ver rc12 -to dest-project
$ polyaxon artifacts transfer -p acme/foobar -ver rc12 --to-project=dest-project
Options:
-p, --project TEXT The project name, e.g. 'mnist' or 'acme/mnist'.
-ver, --version TEXT The artifact version, e.g. 'v1.3.4' or 'rc1' or
'latest'.
-to, --to-project TEXT The project to transfer the version to.
--help Show this message and exit.
artifacts pull
Usage: polyaxon artifacts pull [OPTIONS]
Package and download an artifact version or many artifact versions to a
local path with or without assets.
Uses /docs/core/cli/#caching
Examples:
$ polyaxon artifacts pull -ver rc12
$ polyaxon artifacts pull -p acme/foobar -q"stage: production, name: %-v1%"
$ polyaxon artifacts pull -p acme/foobar -a--path /tmp/versions
Options:
-p, --project TEXT The project name, e.g. 'mnist' or 'acme/mnist'.
-ver, --version TEXT The artifact version, e.g. 'v1.3.4' or 'rc1' or
'latest'.
-a, --all-versions To pull all versions.
-q, --query TEXT To filter the versions based on a query spec.
-l, --limit INTEGER To limit the list of runs.
-off, --offset INTEGER To offset the list of runs.
--path, --path-to PATH Optional path where the artifact versions are
persisted, default value is taken from the env var:
`POLYAXON_OFFLINE_ROOT`.
--no-artifacts To disable downloading the run's artifacts and only
persist the metadata.
--help Show this message and exit.
artifacts push
Usage: polyaxon artifacts push [OPTIONS]
Push local packaged artifact version or multiple artifact versions to a
remove server.
Uses /docs/core/cli/#caching
Examples:
$ polyaxon artifacts push -ver rc12
$ polyaxon artifacts push -p acme/foobar --path /tmp/versions
$ polyaxon artifacts pull -p acme/foobar -a--path /tmp/versions
Options:
-p, --project TEXT The project name, e.g. 'mnist' or 'acme/mnist'.
-ver, --version TEXT The artifact version, e.g. 'v1.3.4' or 'rc1' or
'latest'.
-a, --all-versions To push all versions.
-c, --clean To clean the version(s)local data after syncing.
--path, --path-from PATH Optional path where the artifact versions are
persisted, default value is taken from the env
var: `POLYAXON_OFFLINE_ROOT`.
--reset-project Optional, to ignore the owner/project of the local
version and use the owner/project provided or
resolved from the current project.
--force Flag to force register if the version already
exists.
--help Show this message and exit.
artifacts dashboard
Usage: polyaxon artifacts dashboard [OPTIONS]
Open this artifact version's dashboard details in browser.
Options:
-p, --project TEXT The project name, e.g. 'mnist' or 'acme/mnist'.
-ver, --version TEXT The artifact version, e.g. 'v1.3.4' or 'rc1' or
'latest'.
-y, --yes Automatic yes to prompts. Assume "yes" as answer to
all prompts and run non-interactively.
--url Print the url of the dashboard for this artifact
version.
--help Show this message and exit.
We do our best to make this documentation clear and user friendly, if you see anything that is incorrect or have any questions, feel free to reach out!