Registry¶
Note
New in version 0.15.0.
verta registry create¶
Create a new entry.
For example, to create a new model with name BERT, run
verta registry create registeredmodel BERT
or to create a BERT model with the version latest, run
verta registry create registeredmodelversion BERT latest
verta registry create [OPTIONS] COMMAND [ARGS]...
registeredmodel¶
Create a new registeredmodel entry.
verta registry create registeredmodel [OPTIONS] MODEL_NAME
Options
- -d, --description <description>¶
Description.
- -l, --label <label>¶
Labels to be associated with the object.
- -v, --visibility <visibility>¶
Visibility level of the object.
- Default:
private
- Options:
private | org
- -w, --workspace <workspace>¶
Workspace to use.
- --task-type <task_type>¶
Task type.
- Default:
other
- Options:
other | classification | clustering | detection | regression | transcription | translation
- --data-type <data_type>¶
Data type.
- Default:
other
- Options:
other | audio | image | tabular | text | video
Arguments
- MODEL_NAME¶
Required argument
registeredmodelversion¶
Create a new registeredmodelversion entry.
verta registry create registeredmodelversion [OPTIONS] MODEL_NAME VERSION_NAME
Options
- --artifact <artifact>¶
Path to an artifact required for the model. The format is –artifact artifact_key=path_to_artifact.
- --attribute <attribute>¶
Attribute to be associated with the model version. The format is –attribute attribute_key=value.
- --custom-module <custom_module>¶
Path to custom module file or directory.
- --from-run <from_run>¶
ID of the Experiment Run to enter into the model registry. This option cannot be provided alongside other options, except for –workspace.
- -d, --description <description>¶
Description.
- -l, --label <label>¶
Labels to be associated with the object.
- --model <model>¶
Path to the model.
- --no-custom-modules¶
Flag to not upload any custom modules.
- --requirements <requirements>¶
Path to the requirements.txt file.
- -w, --workspace <workspace>¶
Workspace to use.
- --input-description <input_description>¶
Input description.
- --hide-input-label¶
Flag to hide input label.
- --output-description <output_description>¶
Output description.
- --hide-output-label¶
Flag to hide output label.
Arguments
- MODEL_NAME¶
Required argument
- VERSION_NAME¶
Required argument
verta registry get¶
Get detailed information about an object.
For example, to see information about a registered model named BERT, run
verta registry get registeredmodel BERT
or to get the BERT model with the version latest, run
verta registry get registeredmodelversion BERT latest
verta registry get [OPTIONS] COMMAND [ARGS]...
registeredmodel¶
Get detailed information about a model.
verta registry get registeredmodel [OPTIONS] MODEL_NAME
Options
- -o, --output <output>¶
Print the output in the given format instead of regular text.
- Options:
json
- -w, --workspace <workspace>¶
Workspace to use
Arguments
- MODEL_NAME¶
Required argument
registeredmodelversion¶
Get detailed information about a model version.
verta registry get registeredmodelversion [OPTIONS] MODEL_NAME VERSION_NAME
Options
- -o, --output <output>¶
Print the output in the given format instead of regular text.
- Options:
json
- -w, --workspace <workspace>¶
Workspace to use
Arguments
- MODEL_NAME¶
Required argument
- VERSION_NAME¶
Required argument
verta registry update¶
Update an existing entry.
For example, to update a registered model named BERT with a new label, run
verta registry update registeredmodel BERT -l “<label>”
or to update the version named latest of a model named BERT with a new label, run
verta registry update registeredmodelversion BERT latest -l “<label>”
verta registry update [OPTIONS] COMMAND [ARGS]...
registeredmodel¶
Update an existing registeredmodel entry.
verta registry update registeredmodel [OPTIONS] MODEL_NAME
Options
- -d, --description <description>¶
Description.
- -l, --label <label>¶
Label to be associated with the object.
- -w, --workspace <workspace>¶
Workspace to use.
Arguments
- MODEL_NAME¶
Required argument
registeredmodelversion¶
Update an existing registeredmodelversion entry.
verta registry update registeredmodelversion [OPTIONS] MODEL_NAME VERSION_NAME
Options
- --artifact <artifact>¶
Path to the artifact required for the model. The format is –artifact artifact_key=path_to_artifact.
- --attribute <attribute>¶
Attribute to be associated with the model version. The format is –attribute attribute_key=value.
- --custom-module <custom_module>¶
Path to custom module file or directory.
- -d, --description <description>¶
Description.
- -l, --label <label>¶
Label to be associated with the object.
- --model <model>¶
Path to the model.
- --no-custom-modules¶
Flag to not upload any custom modules.
- --overwrite¶
Overwrite model and artifacts if already logged.
- --requirements <requirements>¶
Path to the requirements.txt file.
- -w, --workspace <workspace>¶
Workspace to use.
- --input-description <input_description>¶
Input description.
- --hide-input-label¶
Flag to hide input label.
- --output-description <output_description>¶
Output description.
- --hide-output-label¶
Flag to hide output label.
Arguments
- MODEL_NAME¶
Required argument
- VERSION_NAME¶
Required argument
verta registry list¶
List all objects available.
For example, to list all registered models, run
verta registry list registeredmodel
or to get all versions of the model BERT available, run
verta registry list registeredmodelversion BERT
verta registry list [OPTIONS] COMMAND [ARGS]...
registeredmodel¶
List all models available.
verta registry list registeredmodel [OPTIONS]
Options
- --filter <filter>¶
Filters to be applied when listing. See the documentation for a complete list.
- -o, --output <output>¶
Print the output in the given format instead of regular text.
- Options:
json
- -w, --workspace <workspace>¶
Workspace to use
registeredmodelversion¶
List all models available.
verta registry list registeredmodelversion [OPTIONS] [MODEL_NAME]
Options
- --filter <filter>¶
Filters to be applied when listing. See the documentation for a complete list.
- -o, --output <output>¶
Print the output in the given format instead of regular text.
- Options:
json
- -w, --workspace <workspace>¶
Workspace to use
Arguments
- MODEL_NAME¶
Optional argument