mlflow.prophet

The mlflow.prophet 模块提供用于记录和加载 Prophet 模型的 API。该模块以以下方式导出单变量 Prophet 模型：

Prophet (native) format: 这是可以通过 Prophet APIs 访问的主要 flavor。
mlflow.pyfunc: 供通用基于 pyfunc 的部署工具使用，也用于对历史预测进行批量审计。

mlflow.prophet.get_default_conda_env()[source]

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

mlflow.prophet.get_default_pip_requirements()[source]

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

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

从本地文件或 run 中加载 Prophet 模型。

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

一个 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)[source]

将 Prophet 模型作为 MLflow 工件记录到当前运行中。

Parameters

pr_model – 要保存的 Prophet 模型。
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": [
                "prophet==x.y.z"
            ],
        },
    ],
}
```
code_paths –
本地文件系统中指向 Python 文件依赖（或包含文件依赖的目录）路径的列表。这些文件在模型加载时会被预先添加到系统路径中。如果为某个模型声明了依赖文件且多个文件之间存在导入依赖关系，那么这些文件应从一个共同的根路径声明相对导入，以避免在加载模型时发生导入错误。

有关 code_paths 功能、推荐的使用模式和限制的详细说明，请参阅 code_paths usage guide。
registered_model_name – 如果提供，则在 registered_model_name 下创建一个模型版本，如果不存在具有该名称的注册模型，则同时创建一个注册模型。
signature –
一个描述模型输入和输出的 ModelSignature 类的实例。如果未指定，但是提供了 input_example，则会根据提供的输入示例和模型自动推断出 signature。要在提供输入示例时禁用自动 signature 推断，请将 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 array，其中示例将通过将其转换为列表的方式序列化为 json。字节使用 base64 编码。当 signature 参数为 None 时，输入示例用于推断模型签名。
await_registration_for – 等待模型版本完成创建并进入 READY 状态的秒数。默认情况下，该函数等待五分钟。指定 0 或 None 以跳过等待。
pip_requirements – 可以是 pip 依赖字符串的可迭代对象 (例如 ["prophet", "-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 文件中的自定义元数据字典。
name – 模型名称。
params – 一个用于与模型一同记录的参数字典。
tags – 一个要与模型一起记录的标签字典。
model_type – 模型的类型。
step – 在该步记录模型输出和指标
model_id – 模型的 ID。

Returns

一个 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)[source]

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

Parameters

pr_model – Prophet 模型（一个已在时间序列上拟合的 Prophet() 预测器实例）。
path – 要保存序列化模型（以 JSON 格式）的本地路径。
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": [
                "prophet==x.y.z"
            ],
        },
    ],
}
```
code_paths –
本地文件系统中指向 Python 文件依赖（或包含文件依赖的目录）路径的列表。这些文件在模型加载时会被预先添加到系统路径中。如果为某个模型声明了依赖文件且多个文件之间存在导入依赖关系，那么这些文件应从一个共同的根路径声明相对导入，以避免在加载模型时发生导入错误。

有关 code_paths 功能、推荐的使用模式和限制的详细说明，请参阅 code_paths usage guide。
mlflow_model – mlflow.models.Model 此 flavor 正在被添加到。
signature –
一个ModelSignature类的实例，用于描述模型的输入和输出。如果未指定但提供了input_example，则会基于提供的输入示例和模型自动推断出一个 signature。要在提供输入示例时禁用自动 signature 推断，请将 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 array，其中示例将通过将其转换为列表的方式序列化为 json。字节使用 base64 编码。当 signature 参数为 None 时，输入示例用于推断模型签名。
pip_requirements – 可以是 pip 依赖字符串的可迭代对象（例如 ["prophet", "-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 文件中的自定义元数据字典。