Overview

A component can have one or more versions, each version:

• Conveys useful information about a specific component version/variant.
• Reflects changes in the logic of your component where previous versions are still used or referenced by runs.
• Can have multiple versions, similar to docker images, to avoid breaking old experiments and workflows.

CLI Reference

You can check the complete components CLI reference here or by using polyaxon components --help.

Client Reference

Polyaxon's ProjectClient library exposes all methods to:

• list_component_versions
• get_component_version
• create_component_version
• patch_component_version
• register_component_version
• copy_component_version
• transfer_component_version
• delete_component_version
• stage_component_version
• pull_component_version

Component version creation

You can create your component versions using the CLI, API, or the UI.

CLI

polyaxon components register --version OWNER_NAME/COMPONENT_NAME[:tag] --description ... --tags tag1,tag2,... -f path/to/polyaxonfile.yaml

UI

In the project, open the Add menu and choose New component version. The example below shows the creation form in acme/tensorboard.

Component version creation from a run

Polyaxon snapshots the component used to create a run. On the run's Info page, select the state identifier under Component to register that state as a version. The example below shows an unregistered component state in acme/tensorboard:

For an already registered state, the dialog lists the component versions and links to related runs:

Component version overview and definition

CLI

polyaxon components get -ver VERSION_NAME -p OWNER/PROJECT_NAME

UI

Component version stage changes

You can update the stage of the component version to reflect the production-readiness

CLI

polyaxon components stage -ver VERSION_NAME -to production ...

UI

Component version admin

CLI

You can override a component version with the --force flag:

polyaxon components register -f ./path/to/polyaxonfile.yaml -ver VERSION_NAME ... --force

Or update specific info:

polyaxon components update -ver ...

Or delete the version:

polyaxon components delete -ver ...

UI

You can manage a component version using the UI