mlflow.webhooks

MLflow webhooks 模块。

此模块为 MLflow 模型注册表事件提供 webhook 功能。

class mlflow.webhooks.ModelVersionAliasCreatedPayload[source]

基类： TypedDict

在为模型版本创建别名时发送的有效负载。

示例有效负载：

{
    "name": "example_model",
    "alias": "example_alias",
    "version": "1",
}

alias: str: 正在创建的别名。

classmethod example() → mlflow.webhooks.types.ModelVersionAliasCreatedPayload[source]

name: str: 注册模型的名称。

version: str: 该别名被分配到的模型版本。

class mlflow.webhooks.ModelVersionAliasDeletedPayload[source]

基类： TypedDict

当从模型版本删除别名时发送的有效负载。

示例有效负载：

{
    "name": "example_model",
    "alias": "example_alias",
}

alias: str: 被删除的别名。

classmethod example() → mlflow.webhooks.types.ModelVersionAliasDeletedPayload[source]

name: str: 注册模型的名称。

class mlflow.webhooks.ModelVersionCreatedPayload[source]

基类: TypedDict

创建新模型版本时发送的有效负载。

示例有效负载:

{
    "name": "example_model",
    "version": "1",
    "source": "models:/123",
    "run_id": "abcd1234abcd5678",
    "tags": {"example_key": "example_value"},
    "description": "An example model version",
}

description: str | None: 模型版本的描述。

classmethod example() → mlflow.webhooks.types.ModelVersionCreatedPayload[source]

name: str: 注册模型的名称。

run_id: str | None: 与模型版本相关联的 run ID（如适用）。

source: str: The source URI of the model version.

tags: dict[str, str]: 与模型版本关联的标签。

version: str: 模型的版本。

class mlflow.webhooks.ModelVersionTagDeletedPayload[source]

基类：TypedDict

当从模型版本删除标签时发送的有效负载。

示例有效载荷：

{
    "name": "example_model",
    "version": "1",
    "key": "example_key",
}

classmethod example() → mlflow.webhooks.types.ModelVersionTagDeletedPayload[source]

key: str: 正在删除的标签键。

name: str: 注册模型的名称。

version: str: 模型的版本。

class mlflow.webhooks.ModelVersionTagSetPayload[source]

基类： TypedDict

在为模型版本设置标签时发送的有效负载。

示例有效负载：

{
    "name": "example_model",
    "version": "1",
    "key": "example_key",
    "value": "example_value",
}

classmethod example() → mlflow.webhooks.types.ModelVersionTagSetPayload[source]

key: str: 正在设置的标签键。

name: str: 注册模型的名称。

value: str: 正在设置的标签值。

version: str: 模型的版本。

class mlflow.webhooks.RegisteredModelCreatedPayload[source]

基类: TypedDict

创建新注册模型时发送的有效负载。

示例有效载荷：

{
    "name": "example_model",
    "tags": {"example_key": "example_value"},
    "description": "An example registered model",
}

description: str | None: 已注册模型的描述。

classmethod example() → mlflow.webhooks.types.RegisteredModelCreatedPayload[source]

name: str: 注册模型的名称。

tags: dict[str, str]: 与已注册模型关联的标签。