mlflow.xgboost

mlflow.xgboost 模块提供了用于记录和加载 XGBoost 模型的 API。此模块导出以下口味的 XGBoost 模型：

XGBoost (原生) 格式

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

mlflow.pyfunc

Produced for use by generic pyfunc-based deployment tools and batch inference.

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='ubj', extra_tags=None)

注意

已知 autologging 与以下包版本兼容：2.0.3 <= xgboost <= 3.1.2。在超出此范围的包版本上使用 autologging 可能会失败。

启用（或禁用）XGBoost 到 MLflow 的 autologging 并进行配置。记录以下内容：

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

• 每次迭代的指标（如果指定了 evals）。

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

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

• 训练好的模型，包括：

  • 有效的输入示例。

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

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

参数

• 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 autologging 集成。如果为 False，则启用 XGBoost autologging 集成。

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

• disable_for_unsupported_versions – 如果为 True，则禁用与此 MLflow 客户端版本未经测试或不兼容的 xgboost 版本 autologging。

• silent – 如果为 True，则在 XGBoost autologging 期间抑制 MLflow 的所有事件日志和警告。如果为 False，则在 XGBoost autologging 期间显示所有事件和警告。

• registered_model_name – If given, each time a model is trained, it is registered as a new model version of the registered model with this name. The registered model is created if it does not already exist.

• model_format – 保存模型的文件格式。默认为“ubj”（UBJSON），这是实现最佳性能和跨平台兼容性的推荐格式。也支持“json”和“xgb”格式。

• extra_tags – 要为自动日志记录创建的每个托管运行设置的额外标签的字典。

mlflow.xgboost.get_default_conda_env()

返回

通过调用 save_model() 和 log_model() 生成的 MLflow Models 的默认 Conda 环境。

mlflow.xgboost.get_default_pip_requirements()

返回

此格式生成的 MLflow Models 的默认 pip 要求列表。调用 save_model() 和 log_model() 生成的 pip 环境至少包含这些要求。

mlflow.xgboost.load_model(model_uri, dst_path=None)

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

参数

• 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 方案的更多信息，请参阅 引用 Artifacts。

• dst_path – The local filesystem path to which to download the model artifact. This directory must already exist. If unspecified, a local output path will be created.

返回

XGBoost 模型。根据保存的模型类规范，是 xgboost.Booster 的实例或实现 scikit-learn API 的 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='ubj', 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)

将 XGBoost 模型记录为当前运行的 MLflow Artifact。

参数

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

• artifact_path – Deprecated. Use name instead.

• conda_env –

  Conda 环境的字典表示形式或 conda 环境 yaml 文件的路径。如果提供，这将描述模型应运行的环境。至少，它应该指定 get_default_conda_env() 中包含的依赖项。如果为 None，则会将通过 mlflow.models.infer_pip_requirements() 推断的 pip 要求添加到模型中。如果要求推断失败，则回退使用 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 –

  A list of local filesystem paths to Python file dependencies (or directories containing file dependencies). These files are prepended to the system path when the model is loaded. Files declared as dependencies for a given model should have relative imports declared from a common root path if multiple files are defined with import dependencies between them to avoid import errors when loading the model.

  For a detailed explanation of code_paths functionality, recommended usage patterns and limitations, see the 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 = ...  # compute model predictions
  signature = infer_signature(train, predictions)
  

• input_example – 一个或多个有效的模型输入实例。输入示例用作要馈送给模型的数据的提示。它将被转换为 Pandas DataFrame，然后使用 Pandas 的面向拆分（split-oriented）格式序列化为 json，或者转换为 numpy 数组，其中示例将通过转换为列表来序列化为 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.txt"）。如果提供，这将描述附加到根据用户当前软件环境自动生成的默认 pip 要求集中的其他 pip 要求。要求和约束都会被自动解析并写入 requirements.txt 和 constraints.txt 文件，并作为模型的一部分存储。要求也会被写入模型 Conda 环境 (conda.yaml) 文件的 pip 部分。

  警告

  以下参数不能同时指定

  • conda_env

  • pip_requirements

  • extra_pip_requirements

  此示例演示了如何使用 pip_requirements 和 extra_pip_requirements 指定 pip requirements。

• model_format – 保存模型的文件格式。默认为“ubj”（UBJSON），这是实现最佳性能和跨平台兼容性的推荐格式。也支持“json”和“xgb”格式。

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

• name – 模型名称。

• params – 要与模型一起记录的参数字典。

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

• model_type – 模型的类型。

• step – 记录模型输出和指标的步骤

• model_id – 模型的 ID。

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

返回

一个 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='ubj', metadata=None)

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

参数

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

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

• conda_env –

  Conda 环境的字典表示形式或 conda 环境 yaml 文件的路径。如果提供，这将描述模型应运行的环境。至少，它应该指定 get_default_conda_env() 中包含的依赖项。如果为 None，则会将通过 mlflow.models.infer_pip_requirements() 推断的 pip 要求添加到模型中。如果要求推断失败，则回退使用 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 –

  A list of local filesystem paths to Python file dependencies (or directories containing file dependencies). These files are prepended to the system path when the model is loaded. Files declared as dependencies for a given model should have relative imports declared from a common root path if multiple files are defined with import dependencies between them to avoid import errors when loading the model.

  For a detailed explanation of code_paths functionality, recommended usage patterns and limitations, see the code_paths usage guide.

• mlflow_model – 要添加此 flavor 的 mlflow.models.Model。

• signature –

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

  from mlflow.models import infer_signature
  
  train = df.drop_column("target_label")
  predictions = ...  # compute model predictions
  signature = infer_signature(train, predictions)
  

• input_example – 一个或多个有效的模型输入实例。输入示例用作要馈送给模型的数据的提示。它将被转换为 Pandas DataFrame，然后使用 Pandas 的面向拆分（split-oriented）格式序列化为 json，或者转换为 numpy 数组，其中示例将通过转换为列表来序列化为 json。字节将进行 base64 编码。当 signature 参数为 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.txt"）。如果提供，这将描述附加到根据用户当前软件环境自动生成的默认 pip 要求集中的其他 pip 要求。要求和约束都会被自动解析并写入 requirements.txt 和 constraints.txt 文件，并作为模型的一部分存储。要求也会被写入模型 Conda 环境 (conda.yaml) 文件的 pip 部分。

  警告

  以下参数不能同时指定

  • conda_env

  • pip_requirements

  • extra_pip_requirements

  此示例演示了如何使用 pip_requirements 和 extra_pip_requirements 指定 pip requirements。

• model_format – 保存模型的文件格式。默认为“ubj”（UBJSON），这是实现最佳性能和跨平台兼容性的推荐格式。也支持“json”和“xgb”格式。

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