logged_models

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

Overview

Name	logged_models
Type	Resource
Id	databricks_workspace.ml.logged_models

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
▶model	object	A logged model message includes logged model attributes, tags, registration info, params, and<br /> linked run metrics.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	model_id, deployment_name		Get a logged model.
create	insert	deployment_name, experiment_id		Create a logged model.
delete_tag	delete	model_id, tag_key, deployment_name		Delete a tag on a logged model.
delete	delete	model_id, deployment_name		Delete a logged model.
finalize	exec	model_id, deployment_name, status		Finalize a logged model.
log_params	exec	model_id, deployment_name		Logs params for a logged model. A param is a key-value pair (string key, string value). Examples
search	exec	deployment_name		Search for Logged Models that satisfy specified search criteria.
set_tags	exec	model_id, deployment_name		Set tags for a logged 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)
model_id	string	The ID of the logged model to set the tags on.
tag_key	string	The tag key.

SELECT examples

get

Get a logged model.

SELECT
model
FROM databricks_workspace.ml.logged_models
WHERE model_id = '{{ model_id }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
;

INSERT examples

create

Create a logged model.

INSERT INTO databricks_workspace.ml.logged_models (
experiment_id,
model_type,
name,
params,
source_run_id,
tags,
deployment_name
)
SELECT 
'{{ experiment_id }}' /* required */,
'{{ model_type }}',
'{{ name }}',
'{{ params }}',
'{{ source_run_id }}',
'{{ tags }}',
'{{ deployment_name }}'
RETURNING
model
;

Manifest

# Description fields are for documentation purposes
- name: logged_models
props:
  - name: deployment_name
    value: "{{ deployment_name }}"
    description: Required parameter for the logged_models resource.
  - name: experiment_id
    value: "{{ experiment_id }}"
    description: |
      The ID of the experiment that owns the model.
  - name: model_type
    value: "{{ model_type }}"
    description: |
      The type of the model, such as ``"Agent"``, ``"Classifier"``, ``"LLM"``.
  - name: name
    value: "{{ name }}"
    description: |
      The name of the model (optional). If not specified one will be generated.
  - name: params
    description: |
      Parameters attached to the model.
    value:
      - key: "{{ key }}"
        value: "{{ value }}"
  - name: source_run_id
    value: "{{ source_run_id }}"
    description: |
      The ID of the run that created the model.
  - name: tags
    description: |
      Tags attached to the model.
    value:
      - key: "{{ key }}"
        value: "{{ value }}"

DELETE examples

delete_tag

Delete a tag on a logged model.

DELETE FROM databricks_workspace.ml.logged_models
WHERE model_id = '{{ model_id }}' --required
AND tag_key = '{{ tag_key }}' --required
AND deployment_name = '{{ deployment_name }}' --required
;

delete

Delete a logged model.

DELETE FROM databricks_workspace.ml.logged_models
WHERE model_id = '{{ model_id }}' --required
AND deployment_name = '{{ deployment_name }}' --required
;

Lifecycle Methods

finalize

Finalize a logged model.

EXEC databricks_workspace.ml.logged_models.finalize 
@model_id='{{ model_id }}' --required, 
@deployment_name='{{ deployment_name }}' --required 
@@json=
'{
"status": "{{ status }}"
}'
;

log_params

Logs params for a logged model. A param is a key-value pair (string key, string value). Examples

EXEC databricks_workspace.ml.logged_models.log_params 
@model_id='{{ model_id }}' --required, 
@deployment_name='{{ deployment_name }}' --required 
@@json=
'{
"params": "{{ params }}"
}'
;

search

Search for Logged Models that satisfy specified search criteria.

EXEC databricks_workspace.ml.logged_models.search 
@deployment_name='{{ deployment_name }}' --required 
@@json=
'{
"datasets": "{{ datasets }}", 
"experiment_ids": "{{ experiment_ids }}", 
"filter": "{{ filter }}", 
"max_results": {{ max_results }}, 
"order_by": "{{ order_by }}", 
"page_token": "{{ page_token }}"
}'
;

set_tags

Set tags for a logged model.

EXEC databricks_workspace.ml.logged_models.set_tags 
@model_id='{{ model_id }}' --required, 
@deployment_name='{{ deployment_name }}' --required 
@@json=
'{
"tags": "{{ tags }}"
}'
;