Skip to content

hsml.deployment_version #

DeploymentVersion #

One retained configuration version of a deployment.

A deployment keeps every version it ever had. Exactly one of them is active, and rolling back reactivates an earlier one without copying it. Only the predictor, transformer and model artifact settings belong to a version. The API protocol, request batching, inference logging, scheduling configuration and Knative mode live on the deployment itself and are the same for every version.

active property #

active: bool

Whether this is the version the deployment currently runs.

config_file property #

config_file: str | None

Model server configuration file of this version.

This is a base name inside the version directory, which stores it with a configfile- prefix, or an absolute HopsFS path for a file read from outside the version.

created property #

created: str | None

When this version was created.

created_by property #

created_by: str | None

Who created this version.

feature_logging property #

feature_logging: DeploymentLoggingConfig | None

Feature logging overrides of the predictor.

git_auto_redeploy property #

git_auto_redeploy: bool | None

Whether the deployment redeploys itself when the tracked branch moves.

git_branch property #

git_branch: str | None

Branch of the git repository the deployment tracks.

git_current_commit property #

git_current_commit: str | None

Commit the deployment was last rolled to by git-sync.

git_provider property #

git_provider: str | None

Git provider of the repository.

git_url property #

git_url: str | None

Git repository an agent deployment reads its scripts from.

model_framework property #

model_framework: str | None

Framework of the model this version serves.

model_name property #

model_name: str | None

Name of the model this version serves, or None for a model-less deployment.

model_path property #

model_path: str | None

Path of the model in the model registry.

model_server property #

model_server: str | None

Model server the predictor runs on.

model_version property #

model_version: int | None

Version of the model this version serves.

predictor property #

predictor: str | None

Predictor script of this version.

This is a base name inside the version directory, which stores it with a predictor- prefix, or an absolute HopsFS path for a script read from outside the version.

predictor_env_vars property #

predictor_env_vars: list[str] | None

User environment variables of the predictor, as KEY=VALUE strings.

predictor_environment property #

predictor_environment: str | None

Name of the Python environment the predictor runs in.

predictor_environment_id property #

predictor_environment_id: int | None

Id of the Python environment the predictor runs in.

predictor_resources property #

predictor_resources: PredictorResources | None

Resources allocated to the predictor.

predictor_scaling_config property #

predictor_scaling_config: PredictorScalingConfig | None

Scaling configuration of the predictor.

tracing property #

tracing: DeploymentTracingConfig | None

Tracing configuration of an agent deployment.

transformer property #

transformer: str | None

Transformer script of this version, or None without a transformer.

This is a base name inside the version directory, which stores it with a transformer- prefix, or an absolute HopsFS path for a script read from outside the version.

transformer_env_vars property #

transformer_env_vars: list[str] | None

User environment variables of the transformer, as KEY=VALUE strings.

transformer_environment property #

transformer_environment: str | None

Name of the Python environment the transformer runs in.

transformer_environment_id property #

transformer_environment_id: int | None

Id of the Python environment the transformer runs in.

transformer_resources property #

transformer_resources: TransformerResources | None

Resources allocated to the transformer.

transformer_scaling_config property #

transformer_scaling_config: TransformerScalingConfig | None

Scaling configuration of the transformer.

updated property #

updated: str | None

When this version was last edited in place, or None if it never was.

updated_by property #

updated_by: str | None

Who last edited this version in place.

version property #

version: int

Number of this version, unique within the deployment and never reused.

vllm_image_tag property #

vllm_image_tag: str | None

VLLM image tag of an LLM deployment.

vllm_variant property #

vllm_variant: str | None

VLLM variant of an LLM deployment.