mlflow.xgboost

The mlflow.xgboost 模块提供用于记录和加载 XGBoost 模型的 API。该模块以以下格式导出 XGBoost 模型：

XGBoost (native) format

这是可以加载回 XGBoost 的主要 flavor。

mlflow.pyfunc

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

mlflow.xgboost.autolog(importance_types=None, log_input_examples=False, log_model_signatures=True, log_models=True, log_datasets=True, disable=False, exclusive=False, disable_for_unsupported_versions=False, silent=False, registered_model_name=None, model_format='xgb', extra_tags=None)[source]

注意

Autologging 已知与以下包版本兼容： 2.0.0 <= xgboost <= 3.0.3。使用超出此范围的包版本时，Autologging 可能无法成功。

启用（或禁用）并配置从 XGBoost 到 MLflow 的自动记录。记录以下内容：

  • 在 xgboost.train 中指定的参数。

  • 每次迭代的指标 (如果指定了evals).

  • 在最佳迭代处的指标（如果指定了 early_stopping_rounds）。

  • 以 JSON 文件和图表形式的特征重要性。

  • trained model, including:

    • 一个有效输入的示例。

    • 模型的输入和输出的推断签名。

请注意，scikit-learn API 现在已受支持。

Parameters

  • importance_types – 要记录的重要性类型。如果未指定，默认为 ["weight"]。

  • log_input_examples – 如果 True，则在训练过程中会收集来自训练数据集的输入示例，并与 XGBoost 模型工件一起记录。如果 False，则不会记录输入示例。注意：输入示例是 MLflow 模型属性，只有在 log_models 也为 True 时才会被收集。

  • log_model_signatures – 如果 True， ModelSignatures 在训练过程中会与 XGBoost 模型工件一起收集并记录，描述模型的输入和输出。如果 False， 则不会记录这些签名。 注意：模型签名是 MLflow 模型属性，只有在 log_models 也为 True 时才会被收集。

  • log_models – 如果 True，训练好的模型将作为 MLflow 模型工件被记录。 如果 False，训练好的模型不会被记录。 输入示例和模型签名（它们是 MLflow 模型的属性）在 log_models 为 False 时也会被省略。

  • log_datasets – 如果 True，则会将训练和验证数据集信息记录到 MLflow Tracking（如果适用）。如果 False，则不记录数据集信息。

  • disable – 如果 True，则禁用 XGBoost 自动记录集成。 如果 False，则启用 XGBoost 自动记录集成。

  • exclusive – 如果 True，自动记录的内容不会记录到用户创建的 fluent 运行。 如果 False，自动记录的内容会记录到活动的 fluent 运行，该运行可能是用户创建的。

  • disable_for_unsupported_versions – 如果 True，对未经过与此版本的 MLflow 客户端测试或与之不兼容的 xgboost 版本禁用自动记录功能。

  • silent – 如果 True，在 XGBoost 自动记录期间抑制来自 MLflow 的所有事件日志和警告。如果 False，在 XGBoost 自动记录期间显示所有事件和警告。

  • registered_model_name – 如果提供，每次训练模型时，会将模型注册为具有此名称的注册模型的新版本。如果该注册模型尚不存在，则会创建它。

  • model_format – 模型要保存的文件格式。

  • extra_tags – 一个字典，用于在 autologging 创建的每个托管运行上设置额外标签。

mlflow.xgboost.get_default_conda_env()[source]
Returns

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

mlflow.xgboost.get_default_pip_requirements()[source]
Returns

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

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

从本地文件或运行中加载 XGBoost 模型。

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

一个 XGBoost 模型。根据已保存模型类的规范，为 xgboost.Booster 或 XGBoost scikit-learn 模型的实例。

mlflow.xgboost.log_model(xgb_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, model_format='xgb', 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]

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

Parameters

  • xgb_model – 要保存的 XGBoost 模型（xgboost.Booster 的一个实例，或实现 scikit-learn API 的模型）。

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

  • 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": [
                "xgboost==x.y.z"
            ],
        },
    ],
}

  • code_paths –

    本地文件系统中指向 Python 文件依赖（或包含文件依赖的目录）路径的列表。这些文件在模型加载时会被预先添加到系统路径中。如果为某个模型声明了依赖文件且多个文件之间存在导入依赖关系，那么这些文件应从一个共同的根路径声明相对导入，以避免在加载模型时发生导入错误。

    有关 code_paths 功能、推荐的使用模式和限制的详细说明，请参阅 code_paths usage guide。

  • 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 依赖项字符串的可迭代对象（例如 ["xgboost", "-r requirements.txt", "-c constraints.txt"]）或者本地文件系统上 pip 依赖文件的字符串路径（例如 "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 依赖。

  • model_format – 模型要保存的文件格式。

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

  • name – 模型名称。

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

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

  • model_type – 模型的类型。

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

  • model_id – 模型的 ID。

  • kwargs – 要传递给 xgboost.Booster.save_model 方法的 kwargs。

Returns

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

mlflow.xgboost.save_model(xgb_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, model_format='xgb', metadata=None)[source]

将 XGBoost 模型保存到本地文件系统的某个路径。

Parameters

  • xgb_model – 待保存的 XGBoost 模型（一个 xgboost.Booster 的实例，或实现了 scikit-learn API 的模型）。

  • 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": [
                "xgboost==x.y.z"
            ],
        },
    ],
}

  • code_paths –

    本地文件系统中指向 Python 文件依赖（或包含文件依赖的目录）路径的列表。这些文件在模型加载时会被预先添加到系统路径中。如果为某个模型声明了依赖文件且多个文件之间存在导入依赖关系，那么这些文件应从一个共同的根路径声明相对导入，以避免在加载模型时发生导入错误。

    有关 code_paths 功能、推荐的使用模式和限制的详细说明，请参阅 code_paths usage guide。

  • 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 依赖字符串的可迭代对象 (e.g. ["xgboost", "-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 依赖。

  • model_format – 要保存模型的文件格式。

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