mlflow.catboost

该 mlflow.catboost 模块提供用于记录和加载 CatBoost 模型的 API。该模块以以下风格导出 CatBoost 模型：

CatBoost (native) format

这是可以重新加载到 CatBoost 的主要 flavor。

mlflow.pyfunc

用于通用的基于 pyfunc 的部署工具和批量推理。

mlflow.catboost.get_default_conda_env()[source]
Returns

默认的 Conda 环境，用于由调用 save_model() 和 log_model() 生成的 MLflow 模型。

mlflow.catboost.get_default_pip_requirements()[source]
Returns

该列表列出了由此 flavor 生成的 MLflow Models 的默认 pip 依赖项。 对 save_model() 和 log_model() 的调用会生成一个 pip 环境，该环境至少包含这些依赖项。

mlflow.catboost.load_model(model_uri, dst_path=None)[source]

从本地文件或一次运行中加载 CatBoost 模型。

Parameters

  • model_uri –

    MLflow 模型的 URI 格式的位置。例如：

    • /Users/me/path/to/local/model

    • relative/path/to/local/model

    • s3://my_bucket/path/to/model

    • runs:/<mlflow_run_id>/run-relative/path/to/model

    有关受支持的 URI 方案的更多信息，请参见 Referencing Artifacts。

  • dst_path – 要将模型工件下载到的本地文件系统路径。该目录必须已存在。如果未指定，将创建一个本地输出路径。

Returns

一个 CatBoost 模型（CatBoost、CatBoostClassifier、CatBoostRanker 或 CatBoostRegressor 的实例）

mlflow.catboost.log_model(cb_model, artifact_path: str | None = None, conda_env=None, code_paths=None, registered_model_name=None, signature: mlflow.models.signature.ModelSignature = None, input_example: Union[pandas.core.frame.DataFrame, numpy.ndarray, dict, list, csr_matrix, csc_matrix, str, bytes, tuple] = None, await_registration_for=300, pip_requirements=None, extra_pip_requirements=None, metadata=None, name: str | None = None, params: dict[str, typing.Any] | None = None, tags: dict[str, typing.Any] | None = None, model_type: str | None = None, step: int = 0, model_id: str | None = None, **kwargs)[source]

将 CatBoost 模型记录为当前运行的 MLflow 工件。

Parameters

  • cb_model – CatBoost 模型（一个 CatBoost、CatBoostClassifier、CatBoostRanker 或 CatBoostRegressor 的实例），将被保存。

  • artifact_path – 已弃用。请改用 name。

  • conda_env –

    可以是 Conda 环境的字典表示，或者是指向 conda 环境 yaml 文件的路径。如果提供，这将描述应该在其中运行此模型的环境。至少，它应该指定 get_default_conda_env() 中包含的依赖项。如果 None，会向模型添加一个包含由 mlflow.models.infer_pip_requirements() 推断出的 pip 依赖项的 conda 环境。如果依赖推断失败，则回退使用 get_default_pip_requirements。来自 conda_env 的 pip 依赖项会被写入到一个 pip requirements.txt 文件，而完整的 conda 环境会被写入到 conda.yaml。下面是一个 示例 的 conda 环境字典表示：

    {
    "name": "mlflow-env",
    "channels": ["conda-forge"],
    "dependencies": [
        "python=3.8.15",
        {
            "pip": [
                "catboost==x.y.z"
            ],
        },
    ],
}

  • code_paths – 本地文件系统中指向 Python 文件依赖（或包含文件依赖的目录）的路径列表。这些文件在模型加载时被预先加入到系统路径中。

  • registered_model_name – 如果提供，则在 registered_model_name 下创建一个模型版本，如果不存在具有该名称的注册模型，则同时创建一个注册模型。

  • signature –

    一个 ModelSignature 类的实例，用于描述模型的输入和输出。如果未指定但提供了 input_example，则会根据提供的输入示例和模型自动推断签名。要在提供输入示例时禁用自动签名推断，请将 signature 设置为 False。要手动推断模型签名，请在具有有效模型输入，例如省略了目标列的训练数据集，以及有效模型输出，例如在训练数据集上生成的模型预测的数据集上调用 infer_signature()，例如：

    from mlflow.models import infer_signature

train = df.drop_column("target_label")
predictions = ...  # 计算模型预测
signature = infer_signature(train, predictions)

  • input_example – 一个或多个有效模型输入实例。输入示例用于提示应向模型提供何种数据。它将被转换为一个 Pandas DataFrame，然后使用 Pandas 的 split-oriented 格式序列化为 json，或者转换为一个 numpy array，其中示例将通过将其转换为列表的方式序列化为 json。字节使用 base64 编码。当 signature 参数为 None 时，输入示例用于推断模型签名。

  • await_registration_for – 等待模型版本完成创建并处于 READY 状态的秒数。默认情况下，函数等待五分钟。指定 0 或 None 可跳过等待。

  • pip_requirements – 要么是一个 pip 依赖字符串的可迭代对象 (e.g. ["catboost", "-r requirements.txt", "-c constraints.txt"]) 或者是本地文件系统上 pip requirements 文件的字符串路径 (e.g. "requirements.txt")。如果提供，这会描述运行该模型所需的环境。如果 None，则会从当前软件环境通过 mlflow.models.infer_pip_requirements() 推断出默认的依赖列表。如果依赖推断失败，则回退使用 get_default_pip_requirements。依赖项和约束会被自动解析并分别写入 requirements.txt 和 constraints.txt 文件中，并作为模型的一部分存储。依赖项也会被写入模型的 conda 环境 (conda.yaml) 文件的 pip 部分。

  • extra_pip_requirements –

    要么是一个 pip 需求字符串的可迭代对象（例如 ["pandas", "-r requirements.txt", "-c constraints.txt"]），要么是本地文件系统上 pip requirements 文件的字符串路径（例如 "requirements.txt"）。如果提供，该参数描述了附加的 pip 依赖，这些依赖会被追加到基于用户当前软件环境自动生成的默认 pip 依赖集合中。requirements 和 constraints 会被自动解析并分别写入 requirements.txt 和 constraints.txt 文件，并作为模型的一部分存储。依赖项也会被写入模型的 conda 环境（conda.yaml）文件的 pip 部分。

    警告

    以下参数不能同时指定：

    • conda_env

    • pip_requirements

    • extra_pip_requirements

    This example 演示了如何使用 pip_requirements 和 extra_pip_requirements 指定 pip 依赖。

  • metadata – 传递给模型并存储在 MLmodel 文件中的自定义元数据字典。

  • name – 模型名称。

  • params – 一个用于与模型一同记录的参数字典。

  • tags – 一个要与模型一起记录的标签字典。

  • model_type – 模型的类型。

  • step – 在该步记录模型输出和指标

  • model_id – 模型的 ID。

  • kwargs – 传递给 CatBoost.save_model 方法的 kwargs。

Returns

一个 ModelInfo 实例，包含已记录模型的元数据。

mlflow.catboost.save_model(cb_model, path, conda_env=None, code_paths=None, mlflow_model=None, signature: mlflow.models.signature.ModelSignature = None, input_example: Union[pandas.core.frame.DataFrame, numpy.ndarray, dict, list, csr_matrix, csc_matrix, str, bytes, tuple] = None, pip_requirements=None, extra_pip_requirements=None, metadata=None, **kwargs)[source]

将 CatBoost 模型保存到本地文件系统的路径上。

Parameters

  • cb_model – 要保存的 CatBoost 模型（一个 CatBoost、CatBoostClassifier、CatBoostRanker 或 CatBoostRegressor 的实例）。

  • path – 模型要保存的本地路径。

  • conda_env –

    可以是 Conda 环境的字典表示，也可以是指向 conda 环境 yaml 文件的路径。如果提供，描述了运行此模型所需的环境。至少，应指定 get_default_conda_env() 中包含的依赖项。如果 None，将向模型添加一个 conda 环境，其 pip 依赖由 mlflow.models.infer_pip_requirements() 推断。如果依赖推断失败，则回退使用 get_default_pip_requirements。来自 conda_env 的 pip 依赖会写入 pip requirements.txt 文件，完整的 conda 环境会写入 conda.yaml。下面是一个 示例 的 conda 环境字典表示：

    {
    "name": "mlflow-env",
    "channels": ["conda-forge"],
    "dependencies": [
        "python=3.8.15",
        {
            "pip": [
                "catboost==x.y.z"
            ],
        },
    ],
}

  • code_paths – 指向 Python 文件依赖的本地文件系统路径列表（或包含文件依赖的目录）。这些文件在模型加载时会被 预先添加 到系统路径中。

  • mlflow_model – mlflow.models.Model 此 flavor 正在被添加到。

  • signature –

    一个 ModelSignature 类的实例，用于描述模型的输入和输出。如果未指定但提供了 input_example，则会根据提供的输入示例和模型自动推断签名。要在提供输入示例时禁用自动签名推断，请将 signature 设置为 False。要手动推断模型签名，请在具有有效模型输入，例如省略了目标列的训练数据集，以及有效模型输出，例如在训练数据集上生成的模型预测的数据集上调用 infer_signature()，例如：

    from mlflow.models import infer_signature

train = df.drop_column("target_label")
predictions = ...  # 计算模型预测
signature = infer_signature(train, predictions)

  • input_example – 一个或多个有效模型输入实例。输入示例用于提示应向模型提供何种数据。它将被转换为一个 Pandas DataFrame，然后使用 Pandas 的 split-oriented 格式序列化为 json，或者转换为一个 numpy array，其中示例将通过将其转换为列表的方式序列化为 json。字节使用 base64 编码。当 signature 参数为 None 时，输入示例用于推断模型签名。

  • pip_requirements – 要么是一个 pip 依赖字符串的可迭代对象 （例如 ["catboost", "-r requirements.txt", "-c constraints.txt"]）或本地文件系统上 pip requirements 文件的字符串路径（例如 "requirements.txt"）。如果提供，这描述了该模型应在其中运行的环境。如果 None，默认的依赖列表会由 mlflow.models.infer_pip_requirements() 从当前软件环境中推断出。如果依赖推断失败，则会回退到使用 get_default_pip_requirements。依赖和约束会被自动解析并分别写入 requirements.txt 与 constraints.txt 文件，并作为模型的一部分进行存储。依赖项也会被写入模型的 conda 环境（conda.yaml）文件的 pip 部分。

  • extra_pip_requirements –

    要么是一个 pip 需求字符串的可迭代对象（例如 ["pandas", "-r requirements.txt", "-c constraints.txt"]），要么是本地文件系统上 pip requirements 文件的字符串路径（例如 "requirements.txt"）。如果提供，该参数描述了附加的 pip 依赖，这些依赖会被追加到基于用户当前软件环境自动生成的默认 pip 依赖集合中。requirements 和 constraints 会被自动解析并分别写入 requirements.txt 和 constraints.txt 文件，并作为模型的一部分存储。依赖项也会被写入模型的 conda 环境（conda.yaml）文件的 pip 部分。

    警告

    以下参数不能同时指定：

    • conda_env

    • pip_requirements

    • extra_pip_requirements

    This example 演示了如何使用 pip_requirements 和 extra_pip_requirements 指定 pip 依赖。

  • metadata – 传递给模型并存储在 MLmodel 文件中的自定义元数据字典。

  • kwargs – 传递给 CatBoost.save_model 方法的 kwargs。