snowflake.ml.model.Model¶

class snowflake.ml.model.Model¶

Bases: object

Model Object containing multiple versions. Mapping to SQL’s MODEL object.

Methods

delete_version(version_name: str) → None¶

Drop a version of the model.

get_tag(tag_name: str) → Optional[str]¶

Get the value of a tag attached to the model.

Parameters:: tag_name – The name of the tag, can be fully qualified. If not fully qualified, the database or schema of the model will be used.
Returns:: The tag value as a string if the tag is attached, otherwise None.

rename(model_name: str) → None¶

Rename a model. Can be used to move a model when a fully qualified name is provided.

set_tag(tag_name: str, tag_value: str) → None¶

Set the value of a tag, attaching it to the model if not.

Parameters:

tag_name – The name of the tag, can be fully qualified. If not fully qualified, the database or schema of the model will be used.
tag_value – The value of the tag

show_tags() → dict[str, str]¶

Get a dictionary showing the tag and its value attached to the model.

show_versions() → DataFrame¶

Show information about all versions in the model.

Returns:: A Pandas DataFrame showing information about all versions in the model.

unset_tag(tag_name: str) → None¶

Unset a tag attached to a model.

Parameters:: tag_name – The name of the tag, can be fully qualified. If not fully qualified, the database or schema of the model will be used.

version(version_or_alias: str) → ModelVersion¶

Get a model version object given a version name or version alias in the model.

Parameters:: version_or_alias – The name of the version or alias to a version.
Raises:: ValueError – When the requested version does not exist.
Returns:: The model version object.

versions() → list[ModelVersion]¶

Get all versions in the model.

Returns:: A list of ModelVersion objects representing all versions in the model.

Attributes

fully_qualified_name¶: Return the fully qualified name of the model that can be used to refer to it in SQL.