mlflow.promptflow

该 mlflow.promptflow 模块提供了用于记录和加载 Promptflow 模型的 API。该模块以以下几种格式导出 Promptflow 模型：

Promptflow (native) format

这是可以通过 Promptflow APIs 访问的主要 flavor。

mlflow.pyfunc

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

mlflow.promptflow.get_default_conda_env()[source]
Returns

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

mlflow.promptflow.get_default_pip_requirements()[source]
Returns

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

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

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

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

    • models:/<model_name>/<model_version>

    • models:/<model_name>/<stage>

    有关受支持的 URI 方案的更多信息，请参见 Referencing Artifacts.

  • dst_path – 要将模型工件下载到的本地文件系统路径。该目录必须已存在。如果未指定，将创建一个本地输出路径。

Returns

一个 Promptflow 模型实例

mlflow.promptflow.log_model(model, artifact_path: Optional[str] = None, conda_env=None, code_paths=None, registered_model_name=None, signature=None, input_example=None, await_registration_for=300, pip_requirements=None, extra_pip_requirements=None, metadata=None, model_config: Optional[dict[str, typing.Any]] = None, prompts: Optional[list[str | Prompt]] = None, name: Optional[str] = None, params: Optional[dict[str, typing.Any]] = None, tags: Optional[dict[str, typing.Any]] = None, model_type: Optional[str] = None, step: int = 0, model_id: Optional[str] = None)[source]

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

Parameters

  • model – 一个由 promptflow.load_flow() 加载的 promptflow model。

  • 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": [
                "promptflow==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 依赖字符串的可迭代对象 (e.g. ["promptflow", "-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 文件中的自定义元数据字典。

  • model_config –

    一个可在推理期间应用于 flow 实例的有效覆盖字典。 这些参数仅用于将模型作为 pyfunc 模型 加载的情况。 这些值不会应用到通过调用 mlflow.promptflow.load_model() 返回的 flow 上。 要覆盖具有 promptflow 风格的已加载 flow 的配置，请直接更新 pf_model.context。

    可覆盖的配置包括：

    connection_provider - 用于 flow 的连接提供程序。有关如何设置连接提供程序的更多详细信息，请查看 https://microsoft.github.io/promptflow/how-to-guides/set-global-configs.html#connection-provider。

    connection_overrides - 用于 flow 的连接名称覆盖。示例： {"aoai_connection": "azure_open_ai_connection"}。 引用连接 ‘aoai_connection’ 的节点将解析为实际连接 ‘azure_open_ai_connection’。

    下面是为模型提供覆盖以使用 Azure 机器学习 工作区连接的示例：

    flow_folder = Path(__file__).parent / "basic"
flow = load_flow(flow_folder)

workspace_resource_id = (
    "azureml://subscriptions/{your-subscription}/resourceGroups/{your-resourcegroup}"
    "/providers/Microsoft.MachineLearningServices/workspaces/{your-workspace}"
)
model_config = {
    "connection_provider": workspace_resource_id,
    "connection_overrides": {"local_conn_name": "remote_conn_name"},
}

with mlflow.start_run():
    logged_model = mlflow.promptflow.log_model(
        flow, name="promptflow_model", model_config=model_config
    )

  • prompts –

    一个在 MLflow Prompt Registry 注册的 prompt URI 列表，用于与模型关联。 Each prompt URI should be in the form prompt:/<name>/<version>. 在与模型关联之前，这些 prompt 应该先在 MLflow Prompt Registry 中注册。

    这将在模型和 prompt 之间创建相互链接。关联的 prompt 可以在存储于 MLmodel 文件中的模型元数据中看到。通过 Prompt Registry UI，你也可以导航到该模型。

    import mlflow

prompt_template = "Hi, {name}! How are you doing today?"

# 在 MLflow Prompt Registry 中注册一个 prompt
mlflow.prompts.register_prompt("my_prompt", prompt_template, description="A simple prompt")

# 使用已注册的 prompt 记录模型
with mlflow.start_run():
    model_info = mlflow.pyfunc.log_model(
        name=MyModel(),
        name="model",
        prompts=["prompt:/my_prompt/1"]
    )

print(model_info.prompts)
# 输出：['prompt:/my_prompt/1']

# 加载 prompt
prompt = mlflow.genai.load_prompt(model_info.prompts[0])

  • name – 模型名称。

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

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

  • model_type – 模型的类型。

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

  • model_id – 模型的 ID。

Returns

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

mlflow.promptflow.save_model(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, model_config: dict[str, typing.Any] | None = None)[source]

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

Parameters

  • model – 由 promptflow.load_flow() 加载的 promptflow 模型。

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

  • 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": [
                "promptflow==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 requirement 字符串的可迭代对象（例如 ["promptflow", "-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 文件中的自定义元数据字典。

  • model_config –

    一个包含可在推理期间应用到 flow 实例的有效覆盖项的字典。这些参数专门用于将模型作为 pyfunc Model 加载的情况。这些值不会应用到通过调用 mlflow.promptflow.load_model() 返回的 flow。要覆盖具有 promptflow 风格的已加载 flow 的配置，请直接更新 pf_model.context。

    可以被覆盖的配置包括：

    connection_provider - 用于 flow 的连接提供程序。有关如何设置 connection provider 的更多详细信息，请访问 https://microsoft.github.io/promptflow/how-to-guides/set-global-configs.html#connection-provider

    connection_overrides - 用于 flow 的连接名称覆盖。示例： {"aoai_connection": "azure_open_ai_connection"}。引用连接 ‘aoai_connection’ 的节点将解析为实际连接 ‘azure_open_ai_connection’。

    下面示例演示如何为模型提供覆盖以使用 Azure 机器学习工作区连接：

    flow_folder = Path(__file__).parent / "basic"
flow = load_flow(flow_folder)

workspace_resource_id = (
    "azureml://subscriptions/{your-subscription}/resourceGroups/{your-resourcegroup}"
    "/providers/Microsoft.MachineLearningServices/workspaces/{your-workspace}"
)
model_config = {
    "connection_provider": workspace_resource_id,
    "connection_overrides": {"local_conn_name": "remote_conn_name"},
}

with mlflow.start_run():
    logged_model = mlflow.promptflow.log_model(
        flow, name="promptflow_model", model_config=model_config
    )