mlflow.pmdarima

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

Pmdarima format

使用 pickle 序列化的 pmdarima 模型实例。

mlflow.pyfunc

供通用基于 pyfunc 的部署工具使用，也用于对历史预测进行批量审计。

Example

import pandas as pd
import mlflow
import mlflow.pyfunc
import pmdarima
from pmdarima import auto_arima


# Define a custom model class
class PmdarimaWrapper(mlflow.pyfunc.PythonModel):
    def load_context(self, context):
        self.model = context.artifacts["model"]

    def predict(self, context, model_input):
        return self.model.predict(n_periods=model_input.shape[0])


# Specify locations of source data and the model artifact
SOURCE_DATA = "https://raw.githubusercontent.com/facebook/prophet/master/examples/example_retail_sales.csv"
ARTIFACT_PATH = "model"

# Read data and recode columns
sales_data = pd.read_csv(SOURCE_DATA)
sales_data.rename(columns={"y": "sales", "ds": "date"}, inplace=True)

# Split the data into train/test
train_size = int(0.8 * len(sales_data))
train, _ = sales_data[:train_size], sales_data[train_size:]

# Create the model
model = pmdarima.auto_arima(train["sales"], seasonal=True, m=12)

# Log the model
with mlflow.start_run():
    wrapper = PmdarimaWrapper()
    mlflow.pyfunc.log_model(
        name="model",
        python_model=wrapper,
        artifacts={"model": mlflow.pyfunc.model_to_dict(model)},
    )

mlflow.pmdarima.get_default_conda_env()[source]

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

mlflow.pmdarima.get_default_pip_requirements()[source]

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

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

从本地文件或运行中加载一个 pmdarima ARIMA 模型或 Pipeline 对象。

Parameters

model_uri –
MLflow 模型的 URI 格式位置。例如：
- /Users/me/path/to/local/model
- relative/path/to/local/model
- s3://my_bucket/path/to/model
- runs://run-relative/path/to/model
- mlflow-artifacts:/path/to/model
有关受支持的 URI 方案的更多信息，请参见 Referencing Artifacts.
dst_path – 要将模型工件下载到的本地文件系统路径。该目录必须已存在。如果未指定，将创建一个本地输出路径。

Returns

一个 pmdarima 模型实例

Example

import pandas as pd
import mlflow
from mlflow.models import infer_signature
import pmdarima
from pmdarima.metrics import smape

# Specify locations of source data and the model artifact
SOURCE_DATA = "https://raw.githubusercontent.com/facebook/prophet/master/examples/example_retail_sales.csv"
ARTIFACT_PATH = "model"

# Read data and recode columns
sales_data = pd.read_csv(SOURCE_DATA)
sales_data.rename(columns={"y": "sales", "ds": "date"}, inplace=True)

# Split the data into train/test
train_size = int(0.8 * len(sales_data))
train = sales_data[:train_size]
test = sales_data[train_size:]

with mlflow.start_run():
    # Create the model
    model = pmdarima.auto_arima(train["sales"], seasonal=True, m=12)

    # Calculate metrics
    prediction = model.predict(n_periods=len(test))
    metrics = {"smape": smape(test["sales"], prediction)}

    # Infer signature
    input_sample = pd.DataFrame(train["sales"])
    output_sample = pd.DataFrame(model.predict(n_periods=5))
    signature = infer_signature(input_sample, output_sample)

    # Log model
    input_example = input_sample.head()
    model_info = mlflow.pmdarima.log_model(
        model, name=ARTIFACT_PATH, signature=signature, input_example=input_example
    )

# Load the model
loaded_model = mlflow.pmdarima.load_model(model_info.model_uri)
# Forecast for the next 60 days
forecast = loaded_model.predict(n_periods=60)
print(f"forecast: {forecast}")

Output

forecast:
234    382452.397246
235    380639.458720
236    359805.611219
...

mlflow.pmdarima.log_model(pmdarima_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]

将一个 pmdarima ARIMA 或 Pipeline 对象记录为当前运行的 MLflow 工件。

Parameters

pmdarima_model – pmdarima ARIMA 或 Pipeline 模型，已在时间序列上被 fit。
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": [
                "pmdarima==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

model = pmdarima.auto_arima(data)
predictions = model.predict(n_periods=30, return_conf_int=False)
signature = infer_signature(data, predictions)
```
警告

如果在pmdarima模型的predict方法中使用置信区间生成（return_conf_int=True），则由于使用原生ARIMA.predict() API 时返回类型为复杂元组，签名将无法被推断。不过，如果使用模型的pyfunc风格，infer_schema将能正常工作。
input_example – 一个或多个有效模型输入的示例。该输入示例用来提示应向模型提供哪些数据。它将被转换为 Pandas DataFrame，然后使用 Pandas 的 split-oriented 格式序列化为 json，或者转换为 numpy 数组，在这种情况下示例将通过转换为列表来序列化为 json。字节会被 base64 编码。当 signature 参数为 None 时，输入示例用于推断模型签名。
await_registration_for – 等待模型版本完成创建并进入 READY 状态的秒数。默认情况下，该函数等待五分钟。指定 0 或 None 以跳过等待。
pip_requirements – 要么是一个 pip 需求字符串的可迭代对象 (e.g. ["pmdarima", "-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 依赖字符串的可迭代对象 (e.g. ["pandas", "-r requirements.txt", "-c constraints.txt"])，也可以是本地文件系统上 pip requirements 文件的字符串路径 (e.g. "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 – 用于 mlflow.models.model.Model 的附加参数

Returns

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

Example

import pandas as pd
import mlflow
from mlflow.models import infer_signature
import pmdarima
from pmdarima.metrics import smape

# Specify locations of source data and the model artifact
SOURCE_DATA = "https://raw.githubusercontent.com/facebook/prophet/master/examples/example_retail_sales.csv"
ARTIFACT_PATH = "model"

# Read data and recode columns
sales_data = pd.read_csv(SOURCE_DATA)
sales_data.rename(columns={"y": "sales", "ds": "date"}, inplace=True)

# Split the data into train/test
train_size = int(0.8 * len(sales_data))
train = sales_data[:train_size]
test = sales_data[train_size:]

with mlflow.start_run():
    # Create the model
    model = pmdarima.auto_arima(train["sales"], seasonal=True, m=12)

    # Calculate metrics
    prediction = model.predict(n_periods=len(test))
    metrics = {"smape": smape(test["sales"], prediction)}

    # Infer signature
    input_sample = pd.DataFrame(train["sales"])
    output_sample = pd.DataFrame(model.predict(n_periods=5))
    signature = infer_signature(input_sample, output_sample)

    # Log model
    mlflow.pmdarima.log_model(model, name=ARTIFACT_PATH, signature=signature)

mlflow.pmdarima.save_model(pmdarima_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]

将 pmdarima ARIMA 模型或 Pipeline 对象保存到本地文件系统的某个路径。

Parameters

pmdarima_model – pmdarima ARIMA 或 Pipeline 模型，已在时间序列上 fit。
path – 用于保存序列化模型（pickle 格式）的本地路径目标。
conda_env –
可以是 Conda 环境的字典表示，或指向 conda environment 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": [
                "pmdarima==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

model = pmdarima.auto_arima(data)
predictions = model.predict(n_periods=30, return_conf_int=False)
signature = infer_signature(data, predictions)
```
警告

如果在 pmdarima 模型的 predict 方法中使用置信区间生成（return_conf_int=True），由于使用原生 ARIMA.predict() API 时返回类型为复杂的元组，签名将无法被推断。不过，如果使用模型的 pyfunc 变体，infer_schema 将能正常工作。
input_example – 一个或多个有效模型输入实例。输入示例用于提示应向模型提供何种数据。它将被转换为一个 Pandas DataFrame，然后使用 Pandas 的 split-oriented 格式序列化为 json，或者转换为一个 numpy array，其中示例将通过将其转换为列表的方式序列化为 json。字节使用 base64 编码。当 signature 参数为 None 时，输入示例用于推断模型签名。
pip_requirements – 要么是一个可迭代的 pip 依赖字符串（例如 ["pmdarima", "-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 文件中的自定义元数据字典。

Example

import pandas as pd
import mlflow
import pmdarima

# Specify locations of source data and the model artifact
SOURCE_DATA = "https://raw.githubusercontent.com/facebook/prophet/master/examples/example_retail_sales.csv"
ARTIFACT_PATH = "model"

# Read data and recode columns
sales_data = pd.read_csv(SOURCE_DATA)
sales_data.rename(columns={"y": "sales", "ds": "date"}, inplace=True)

# Split the data into train/test
train_size = int(0.8 * len(sales_data))
train = sales_data[:train_size]
test = sales_data[train_size:]

with mlflow.start_run():
    # Create the model
    model = pmdarima.auto_arima(train["sales"], seasonal=True, m=12)

    # Save the model to the specified path
    mlflow.pmdarima.save_model(model, "model")