model_registry_model_versions

Creates, updates, deletes, gets or lists a model_registry_model_versions resource.

Overview

Name	model_registry_model_versions
Type	Resource
Id	databricks_workspace.ml.model_registry_model_versions

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
▶model_version	object

search

Name	Datatype	Description
name	string	Unique name of the model
run_id	string	MLflow run ID used when creating `model_version`, if `source` was generated by an experiment run stored in MLflow tracking server.
user_id	string	User that created this `model_version`.
creation_timestamp	integer
current_stage	string	Current stage for this `model_version`.
description	string	Description of this `model_version`.
last_updated_timestamp	integer	Timestamp recorded when metadata for this `model_version` was last updated.
run_link	string	Run Link: Direct link to the run that generated this version
source	string	URI indicating the location of the source model artifacts, used when creating `model_version`
status	string	Current status of `model_version` (FAILED_REGISTRATION, PENDING_REGISTRATION, READY)
status_message	string	Details on current `status`, if it is pending or failed.
▶tags	array	Tags: Additional metadata key-value pairs for this `model_version`.
version	string	Model's version number.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	name, version, deployment_name		Get a model version.
search	select	deployment_name	filter, max_results, order_by, page_token	Searches for specific model versions based on the supplied filter.
create	insert	deployment_name, name, source		Creates a model version.
update	update	deployment_name, name, version		Updates the model version.
delete	exec	name, version, deployment_name		Deletes a model version.
delete_tag	exec	name, version, key, deployment_name		Deletes a model version tag.
get_latest	exec	deployment_name, name		Gets the latest version of a registered model.
set_tag	exec	deployment_name, name, version, key, value		Sets a model version tag.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
deployment_name	string	The Databricks Workspace Deployment Name (default: dbc-abcd0123-a1bc)
key	string	Name of the tag. The name must be an exact match; wild-card deletion is not supported. Maximum size is 250 bytes.
name	string	Name of the registered model that the tag was logged under.
version	string	Model version number that the tag was logged under.
filter	string	String filter condition, like "name='my-model-name'". Must be a single boolean condition, with string values wrapped in single quotes.
max_results	integer	Maximum number of models desired. Max threshold is 10K.
order_by	array	List of columns to be ordered by including model name, version, stage with an optional "DESC" or "ASC" annotation, where "ASC" is the default. Tiebreaks are done by latest stage transition timestamp, followed by name ASC, followed by version DESC.
page_token	string	Pagination token to go to next page based on previous search query.

SELECT examples

get

Get a model version.

SELECT
model_version
FROM databricks_workspace.ml.model_registry_model_versions
WHERE name = '{{ name }}' -- required
AND version = '{{ version }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
;

search

Searches for specific model versions based on the supplied filter.

SELECT
name,
run_id,
user_id,
creation_timestamp,
current_stage,
description,
last_updated_timestamp,
run_link,
source,
status,
status_message,
tags,
version
FROM databricks_workspace.ml.model_registry_model_versions
WHERE deployment_name = '{{ deployment_name }}' -- required
AND filter = '{{ filter }}'
AND max_results = '{{ max_results }}'
AND order_by = '{{ order_by }}'
AND page_token = '{{ page_token }}'
;

INSERT examples

create

Creates a model version.

INSERT INTO databricks_workspace.ml.model_registry_model_versions (
name,
source,
description,
run_id,
run_link,
tags,
deployment_name
)
SELECT 
'{{ name }}' /* required */,
'{{ source }}' /* required */,
'{{ description }}',
'{{ run_id }}',
'{{ run_link }}',
'{{ tags }}',
'{{ deployment_name }}'
RETURNING
model_version
;

Manifest

# Description fields are for documentation purposes
- name: model_registry_model_versions
props:
  - name: deployment_name
    value: "{{ deployment_name }}"
    description: Required parameter for the model_registry_model_versions resource.
  - name: name
    value: "{{ name }}"
    description: |
      Register model under this name
  - name: source
    value: "{{ source }}"
    description: |
      URI indicating the location of the model artifacts.
  - name: description
    value: "{{ description }}"
    description: |
      Optional description for model version.
  - name: run_id
    value: "{{ run_id }}"
    description: |
      MLflow run ID for correlation, if `source` was generated by an experiment run in MLflow tracking server
  - name: run_link
    value: "{{ run_link }}"
    description: |
      MLflow run link - this is the exact link of the run that generated this model version, potentially hosted at another instance of MLflow.
  - name: tags
    description: |
      Additional metadata for model version.
    value:
      - key: "{{ key }}"
        value: "{{ value }}"

UPDATE examples

update

Updates the model version.

UPDATE databricks_workspace.ml.model_registry_model_versions
SET 
name = '{{ name }}',
version = '{{ version }}',
description = '{{ description }}'
WHERE 
deployment_name = '{{ deployment_name }}' --required
AND name = '{{ name }}' --required
AND version = '{{ version }}' --required
RETURNING
model_version;

Lifecycle Methods

delete

Deletes a model version.

EXEC databricks_workspace.ml.model_registry_model_versions.delete 
@name='{{ name }}' --required, 
@version='{{ version }}' --required, 
@deployment_name='{{ deployment_name }}' --required
;

delete_tag

Deletes a model version tag.

EXEC databricks_workspace.ml.model_registry_model_versions.delete_tag 
@name='{{ name }}' --required, 
@version='{{ version }}' --required, 
@key='{{ key }}' --required, 
@deployment_name='{{ deployment_name }}' --required
;

get_latest

Gets the latest version of a registered model.

EXEC databricks_workspace.ml.model_registry_model_versions.get_latest 
@deployment_name='{{ deployment_name }}' --required 
@@json=
'{
"name": "{{ name }}", 
"stages": "{{ stages }}"
}'
;

set_tag

Sets a model version tag.

EXEC databricks_workspace.ml.model_registry_model_versions.set_tag 
@deployment_name='{{ deployment_name }}' --required 
@@json=
'{
"name": "{{ name }}", 
"version": "{{ version }}", 
"key": "{{ key }}", 
"value": "{{ value }}"
}'
;