models

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

Overview

Name	models
Type	Resource
Id	databricks_workspace.machinelearning.models

Fields

The following fields are returned by SELECT queries:

searchmodels

Name	Datatype	Description
name	string
user_id	string
creation_timestamp	integer
description	string
last_updated_timestamp	integer
latest_versions	array
tags	array

listmodels

Name	Datatype	Description
name	string
user_id	string
creation_timestamp	integer
description	string
last_updated_timestamp	integer
latest_versions	array
tags	array

getmodel

Model details were returned successfully.

Name	Datatype	Description
registered_model_databricks	object

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
searchmodels	select	deployment_name		Search for registered models based on the specified
listmodels	select	deployment_name		Lists all available registered models, up to the limit specified in
getmodel	select	deployment_name		Get the details of a model. This is a Databricks workspace version of the
createmodel	insert	deployment_name		Creates a new registered model with the name specified in the request body.
updatemodel	update	deployment_name		Updates a registered model.
deletemodel	delete	deployment_name		Deletes a registered model.
renamemodel	exec	deployment_name		Renames a registered model.

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)

SELECT examples

searchmodels

Search for registered models based on the specified

SELECT
name,
user_id,
creation_timestamp,
description,
last_updated_timestamp,
latest_versions,
tags
FROM databricks_workspace.machinelearning.models
WHERE deployment_name = '{{ deployment_name }}' -- required;

listmodels

Lists all available registered models, up to the limit specified in

SELECT
name,
user_id,
creation_timestamp,
description,
last_updated_timestamp,
latest_versions,
tags
FROM databricks_workspace.machinelearning.models
WHERE deployment_name = '{{ deployment_name }}' -- required;

getmodel

Get the details of a model. This is a Databricks workspace version of the

SELECT
registered_model_databricks
FROM databricks_workspace.machinelearning.models
WHERE deployment_name = '{{ deployment_name }}' -- required;

INSERT examples

createmodel

Creates a new registered model with the name specified in the request body.

INSERT INTO databricks_workspace.machinelearning.models (
data__name,
data__description,
data__tags,
deployment_name
)
SELECT 
'{{ name }}',
'{{ description }}',
'{{ tags }}',
'{{ deployment_name }}'
RETURNING
registered_model
;

Manifest

# Description fields are for documentation purposes
- name: models
  props:
    - name: deployment_name
      value: string
      description: Required parameter for the models resource.
    - name: name
      value: required
    - name: description
      value: string
    - name: tags
      value: Array of object

UPDATE examples

updatemodel

Updates a registered model.

UPDATE databricks_workspace.machinelearning.models
SET 
data__name = '{{ name }}',
data__description = '{{ description }}'
WHERE 
deployment_name = '{{ deployment_name }}' --required;

DELETE examples

deletemodel

Deletes a registered model.

DELETE FROM databricks_workspace.machinelearning.models
WHERE deployment_name = '{{ deployment_name }}' --required;

Lifecycle Methods

renamemodel

Renames a registered model.

EXEC databricks_workspace.machinelearning.models.renamemodel 
@deployment_name='{{ deployment_name }}' --required 
@@json=
'{
"name": "{{ name }}", 
"new_name": "{{ new_name }}"
}';