hsml.model #

Model #

NOT_FOUND_ERROR_CODE `class-attribute` `instance-attribute` #

NOT_FOUND_ERROR_CODE = 360000

Metadata object representing a model in the Model Registry.

id `property` `writable` #

Id of the model.

name `property` `writable` #

Name of the model.

version `property` `writable` #

Version of the model.

description `property` `writable` #

Description of the model.

created `property` `writable` #

Creation date of the model.

creator `property` `writable` #

Creator of the model.

environment `property` `writable` #

Input example of the model.

training_metrics `property` `writable` #

Training metrics of the model.

program `property` `writable` #

Executable used to export the model.

user `property` `writable` #

User of the model.

input_example `property` `writable` #

input_example of the model.

framework `property` `writable` #

Framework of the model.

model_schema `property` `writable` #

Model schema of the model.

project_name `property` `writable` #

project_name of the model.

model_registry_id `property` `writable` #

model_registry_id of the model.

model_path `property` #

Path of the model with version folder omitted.

Resolves to /Projects/{project_name}/Models/{name}.

version_path `property` #

Path of the model including version folder.

Resolves to /Projects/{project_name}/Models/{name}/{version}.

model_files_path `property` #

Path of the model files including version and files folder.

Resolves to /Projects/{project_name}/Models/{name}/{version}/Files.

shared_registry_project_name `property` `writable` #

shared_registry_project_name of the model.

save #

save(
    model_path: str,
    await_registration: int = 480,
    keep_original_files: bool = False,
    upload_configuration: dict[str, Any] | None = None,
) -> Model

Persist this model including model files and metadata to the model registry.

PARAMETER	DESCRIPTION
`model_path`	Local or remote (Hopsworks file system) path to the folder where the model files are located, or path to a specific model file. TYPE: `str`
`await_registration`	Awaiting time for the model to be registered in Hopsworks. TYPE: `int` DEFAULT: `480`
`keep_original_files`	If the model files are located in hopsfs, whether to move or copy those files into the Models dataset. Default is False (i.e., model files will be moved) TYPE: `bool` DEFAULT: `False`
`upload_configuration`	When saving a model from outside Hopsworks, the model is uploaded to the model registry using the REST APIs. Each model artifact is divided into chunks and each chunk uploaded independently. This parameter can be used to control the upload chunk size, the parallelism and the number of retries. `upload_configuration` can contain the following keys: * key `chunk_size`: size of each chunk in megabytes. Default 10. * key `simultaneous_uploads`: number of chunks to upload in parallel. Default 3. * key `max_chunk_retries`: number of times to retry the upload of a chunk in case of failure. Default 1. TYPE: `dict[str, Any] \| None` DEFAULT: `None`

RETURNS	DESCRIPTION
`Model`	The model metadata object.

RAISES	DESCRIPTION
`hopsworks.client.exceptions.RestAPIError`	In case the backend encounters an issue

download #

download(local_path: str | None = None) -> str

Download the model files.

PARAMETER	DESCRIPTION
`local_path`	path where to download the model files in the local filesystem TYPE: `str \| None` DEFAULT: `None`

RETURNS	DESCRIPTION
`str`	Absolute path to local folder containing the model files.

RAISES	DESCRIPTION
`hopsworks.client.exceptions.RestAPIError`	In case the backend encounters an issue

delete #

delete()

Delete the model.

Potentially dangerous operation

This operation drops all metadata associated with this version of the model and deletes the model files.

RAISES	DESCRIPTION
`hopsworks.client.exceptions.RestAPIError`	In case the backend encounters an issue

deploy #

deploy(
    name: str | None = None,
    description: str | None = None,
    artifact_version: str | None = None,
    serving_tool: str | None = None,
    script_file: str | None = None,
    config_file: str | None = None,
    resources: PredictorResources | dict | None = None,
    inference_logger: InferenceLogger | dict | None = None,
    inference_batcher: InferenceBatcher
    | dict
    | None = None,
    scaling_configuration: PredictorScalingConfig
    | dict
    | None = None,
    transformer: Transformer | dict | None = None,
    api_protocol: str | None = IE.API_PROTOCOL_REST,
    environment: str | None = None,
) -> deployment.Deployment

Deploy the model.

Example

import hopsworks

project = hopsworks.login()

# get Hopsworks Model Registry handle
mr = project.get_model_registry()

# retrieve the trained model you want to deploy
my_model = mr.get_model("my_model", version=1)

my_deployment = my_model.deploy()

Parameters: name: Name of the deployment. description: Description of the deployment. artifact_version: (Deprecated) Version number of the model artifact to deploy, CREATE to create a new model artifact or MODEL-ONLY to reuse the shared artifact containing only the model files. serving_tool: Serving tool used to deploy the model server. script_file: Path to a custom predictor script implementing the Predict class. config_file: Model server configuration file to be passed to the model deployment. It can be accessed via CONFIG_FILE_PATH environment variable from a predictor or transformer script. For LLM deployments without a predictor script, this file is used to configure the vLLM engine. resources: Resources to be allocated for the predictor. inference_logger: Inference logger configuration. inference_batcher: Inference batcher configuration. scaling_configuration: Scaling configuration for the predictor. transformer: Transformer to be deployed together with the predictor. api_protocol: API protocol to be enabled in the deployment (i.e., 'REST' or 'GRPC'). environment: The inference environment to use.

RETURNS	DESCRIPTION
`deployment.Deployment`	The deployment metadata object of a new or existing deployment.

RAISES	DESCRIPTION
`hopsworks.client.exceptions.RestAPIError`	In case the backend encounters an issue

add_tag #

add_tag(name: str, value: str | dict)

Attach a tag to a model.

A tag consists of a pair. Tag names are unique identifiers across the whole cluster. The value of a tag can be any valid json - primitives, arrays or json objects.

PARAMETER	DESCRIPTION
`name`	Name of the tag to be added. TYPE: `str`
`value`	Value of the tag to be added. TYPE: `str \| dict`

RAISES	DESCRIPTION
`hopsworks.client.exceptions.RestAPIError`	in case the backend fails to add the tag.

set_tag #

set_tag(name: str, value: str | dict)

Deprecated: Use add_tag instead.

PARAMETER	DESCRIPTION
`name`	name of the tag TYPE: `str`
`value`	value of the tag TYPE: `str \| dict`

delete_tag #

delete_tag(name: str)

Delete a tag attached to a model.

PARAMETER	DESCRIPTION
`name`	Name of the tag to be removed. TYPE: `str`

RAISES	DESCRIPTION
`hopsworks.client.exceptions.RestAPIError`	in case the backend fails to delete the tag.

get_tag #

get_tag(name: str) -> str | None

Get the tags of a model.

PARAMETER	DESCRIPTION
`name`	Name of the tag to get. TYPE: `str`

RETURNS	DESCRIPTION
`str \| None`	tag value or `None` if it does not exist.

RAISES	DESCRIPTION
`hopsworks.client.exceptions.RestAPIError`	in case the backend fails to retrieve the tag.

get_tags #

get_tags() -> dict[str, tag.Tag]

Retrieves all tags attached to a model.

RETURNS	DESCRIPTION
`dict[str, tag.Tag]`	Dictionary of tags.

RAISES	DESCRIPTION
`hopsworks.client.exceptions.RestAPIError`	In case of a server error.

get_url #

get_url()

Get url to the model in Hopsworks.

get_feature_view #

get_feature_view(
    init: bool = True, online: bool = False
) -> feature_view.FeatureView | None

Get the parent feature view of this model, based on explicit provenance.

Only accessible, usable feature view objects are returned. Otherwise an Exception is raised. For more details, call the base method - get_feature_view_provenance

PARAMETER DESCRIPTION

init

By default this is set to True. If you require a more complex initialization of the feature view for online or batch scenarios, you should set init to False to retrieve a non initialized feature view and then call init_batch_scoring() or init_serving() with the required parameters.

TYPE: bool DEFAULT: True

online

By default this is set to False and the initialization for batch scoring is considered the default scenario. If you set online to True, the online scenario is enabled and the init_serving() method is called. When inside a deployment, the only available scenario is the online one, thus the parameter is ignored and init_serving is always called (if init is set to True). If you want to override this behaviour, you should set init to False and proceed with a custom initialization.

TYPE: bool DEFAULT: False

RETURNS	DESCRIPTION
`feature_view.FeatureView \| None`	Feature View Object or `None` if it does not exist.

RAISES	DESCRIPTION
`hopsworks.client.exceptions.RestAPIError`	in case the backend fails to retrieve the feature view.

get_feature_view_provenance #

get_feature_view_provenance() -> explicit_provenance.Links

Get the parent feature view of this model, based on explicit provenance.

This feature view can be accessible, deleted or inaccessible. For deleted and inaccessible feature views, only a minimal information is returned.

RETURNS	DESCRIPTION
`explicit_provenance.Links`	Object containing the section of provenance graph requested or `None` if it does not exist.

RAISES	DESCRIPTION
`hopsworks.client.exceptions.RestAPIError`	in case the backend fails to retrieve the feature view provenance.

get_training_dataset_provenance #

get_training_dataset_provenance() -> (
    explicit_provenance.Links
)

Get the parent training dataset of this model, based on explicit provenance.

This training dataset can be accessible, deleted or inaccessible. For deleted and inaccessible training datasets, only a minimal information is returned.

RETURNS	DESCRIPTION
`explicit_provenance.Links`	Object containing the section of provenance graph requested or `None` if it does not exist.

RAISES	DESCRIPTION
`hopsworks.client.exceptions.RestAPIError`	in case the backend fails to retrieve the training dataset provenance.

hsml.model #

Model #

NOT_FOUND_ERROR_CODE class-attribute instance-attribute #

id property writable #

name property writable #

version property writable #

description property writable #

created property writable #

creator property writable #

environment property writable #

training_metrics property writable #

program property writable #

user property writable #

input_example property writable #

framework property writable #

model_schema property writable #

project_name property writable #

model_registry_id property writable #

model_path property #

version_path property #

model_files_path property #

shared_registry_project_name property writable #