mlflow.prophet

The mlflow.prophet 模块提供了一个用于记录和加载 Prophet 模型的 API。此模块以以下形式导出单变量 Prophet 模型

Prophet（原生）格式

这是可以通过 Prophet API 访问的主要形式。

mlflow.pyfunc

为通用的基于 pyfunc 的部署工具和历史预测的批量审计而生成。

mlflow.prophet.get_default_conda_env()[源代码]
返回

对 save_model() 和 log_model() 的调用所生成的 MLflow 模型的默认 Conda 环境。

mlflow.prophet.get_default_pip_requirements()[源代码]
返回

由该形式生成的 MLflow 模型的默认 pip 需求的列表。对 save_model() 和 log_model() 的调用会产生一个至少包含这些需求的 pip 环境。

mlflow.prophet.load_model(model_uri, dst_path=None)[源代码]

从本地文件或运行中加载一个 Prophet 模型。

参数

  • 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.

返回

一个 Prophet 模型实例

mlflow.prophet.log_model(pr_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)[源代码]

将 Prophet 模型记录为当前运行的 MLflow artifact。

参数

  • pr_model – 要保存的 Prophet 模型。

  • artifact_path – Deprecated. Use name instead.

  • 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": [
                "prophet==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

model = Prophet().fit(df)
train = model.history
predictions = model.predict(model.make_future_dataframe(30))
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 需求字符串的可迭代对象（例如 ["prophet", "-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。

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

  • name – 模型名称。

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

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

  • model_type – 模型的类型。

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

  • model_id – 模型的 ID。

返回

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

mlflow.prophet.save_model(pr_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)[源代码]

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

参数

  • pr_model – Prophet 模型（一个已拟合到时间序列的 Prophet() 预测器的实例。

  • path – 要保存序列化模型（JSON 格式）的本地路径。

  • 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": [
                "prophet==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

model = Prophet().fit(df)
train = model.history
predictions = model.predict(model.make_future_dataframe(30))
signature = infer_signature(train, predictions)

  • input_example – 一个或多个有效的模型输入实例。输入示例用作要馈送给模型的数据的提示。它将被转换为 Pandas DataFrame，然后使用 Pandas 的面向拆分（split-oriented）格式序列化为 json，或者转换为 numpy 数组，其中示例将通过转换为列表来序列化为 json。字节将进行 base64 编码。当 signature 参数为 None 时，输入示例用于推断模型签名。

  • pip_requirements – 要么是 pip 需求字符串的可迭代对象（例如 ["prophet", "-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。

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