You are viewing documentation about an older version (1.1.2). View latest version

snowflake.ml.registry.model_registry.ModelRegistry

class snowflake.ml.registry.model_registry.ModelRegistry(*, session: Session, database_name: str = '_SYSTEM_MODEL_REGISTRY', schema_name: str = '_SYSTEM_MODEL_REGISTRY_SCHEMA', create_if_not_exists: bool = False)

Bases: object

Model Management API.

Methods

delete_deployment(model_name, model_version, ...)

Delete the target permanent deployment of the given model.

delete_model(model_name, model_version[, ...])

Delete model with the given ID from the registry.

deploy(model_name, model_version, *, ...[, ...])

Deploy the model with the given deployment name.

get_artifact(name[, version])

Get artifact with the given (name, version).

get_deployment(model_name, model_version, *, ...)

Get the permanent deployment with target name of the given model.

get_history()

Return a dataframe with the history of operations performed on the model registry.

get_metric_value(model_name, model_version, ...)

Return the value of the given metric for the model.

get_metrics(model_name, model_version)

Get all metrics and values stored for the given model.

get_model_description(model_name, model_version)

Get the description of the model.

get_model_history(model_name, model_version)

Return a dataframe with the history of operations performed on the desired model.

get_tag_value(model_name, model_version, ...)

Return the value of the tag for the model.

get_tags([model_name, model_version])

Get all tags and values stored for the target model.

has_metric(model_name, model_version, ...)

Check if a model has a metric with the given name.

has_tag(model_name, model_version, tag_name)

Check if a model has a tag with the given name and value.

list_artifacts(model_name[, model_version])

List all artifacts that associated with given model name and version.

list_deployments(model_name, model_version)

List all permanent deployments that originated from the given model.

list_models()

Lists models contained in the registry.

load_model(model_name, model_version)

Loads the model with the given (model_name + model_version) from the registry into memory.

log_artifact(artifact, name[, version])

Upload and register an artifact to the Model Registry.

log_model(model_name, model_version, *, model)

Uploads and register a model to the Model Registry.

remove_metric(model_name, model_version, ...)

Remove a specific metric entry from the model.

remove_tag(model_name, model_version, tag_name)

Remove target model tag.

set_metric(model_name, model_version, ...)

Set scalar model metric to value.

set_model_description(model_name, ...)

Set the description of the model.

set_tag(model_name, model_version, tag_name)

Set model tag to the model with value.