mlflow.promptflow

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

Promptflow (原生) 格式: 这是可以通过 Promptflow API 访问的主要风格。
mlflow.pyfunc: 为基于通用 pyfunc 的部署工具和批量推理而生成。

mlflow.promptflow.get_default_conda_env()[源代码]

返回:: 通过调用 save_model() 和 log_model() 生成的 MLflow 模型的默认 Conda 环境。

mlflow.promptflow.get_default_pip_requirements()[源代码]

返回:: 此flavor生成的MLflow模型的默认pip需求列表。调用 save_model() 和 log_model() 会生成一个pip环境，该环境至少包含这些需求。

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

备注

实验性功能：此功能可能在未来的版本中无警告地更改或移除。

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

参数:

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 方案的更多信息，请参阅引用工件。
dst_path – 下载模型工件的本地文件系统路径。此目录必须已经存在。如果未指定，将创建一个本地输出路径。

返回: 一个 Promptflow 模型实例

mlflow.promptflow.log_model(model, artifact_path, 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: Dict[str, Any] | None = None, example_no_conversion=None)[源代码]

备注

实验性功能：此功能可能在未来的版本中无警告地更改或移除。

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

参数:

model – 通过 promptflow.load_flow() 加载的 promptflow 模型。
artifact_path – 运行相对的工件路径。
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使用指南 <https://mlflow.org/docs/latest/model/dependencies.html?highlight=code_paths#saving-extra-code-with-an-mlflow-model>`_。
registered_model_name – 如果指定，则在 registered_model_name 下创建一个模型版本，如果给定名称的已注册模型不存在，则同时创建一个已注册模型。
signature – 一个 ModelSignature 类的实例，描述了模型的输入和输出。如果没有指定但提供了 input_example，将根据提供的输入示例和模型自动推断签名。要在提供输入示例时禁用自动签名推断，请将 signature 设置为 False。要手动推断模型签名，请在具有有效模型输入（例如省略了目标列的训练数据集）和有效模型输出（例如在训练数据集上进行的模型预测）的数据集上调用 infer_signature()，例如：
input_example – 一个或多个有效的模型输入实例。输入示例用作提示，指示应向模型提供哪些数据。它将被转换为Pandas DataFrame，然后使用Pandas的面向分割的格式序列化为json，或者是一个numpy数组，其中示例将通过将其转换为列表来序列化为json。字节被base64编码。当``signature``参数为``None``时，输入示例用于推断模型签名。
await_registration_for – 等待模型版本完成创建并处于 READY 状态的秒数。默认情况下，函数等待五分钟。指定 0 或 None 以跳过等待。
pip_requirements – 可以是 pip 需求字符串的可迭代对象（例如 ["promptflow", "-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 需求。
metadata – 传递给模型并在 MLmodel 文件中存储的自定义元数据字典。
model_config – 在推理过程中可以应用于流程实例的有效覆盖字典。这些参数仅用于将模型作为 pyfunc 模型加载的情况。这些值不会应用于从 mlflow.promptflow.load_model() 调用返回的流程。要覆盖带有 promptflow 风格的已加载流程的配置，请直接更新 pf_model.context。可以覆盖的配置包括： connection_provider - 用于流程的连接提供者。访问 https://microsoft.github.io/promptflow/how-to-guides/set-global-configs.html#connection-provider 了解更多关于如何设置连接提供者的详细信息。 connection_overrides - 用于流程的连接名称覆盖。示例： {"aoai_connection": "azure_open_ai_connection"}。引用连接 ‘aoai_connection’ 的节点将被解析为实际连接 ‘azure_open_ai_connection’。提供覆盖以使用 Azure 机器学习工作区连接的模型示例： .. code-block:: python 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, artifact_path=”promptflow_model”, model_config=model_config )
example_no_conversion – 此参数已被弃用，并将在未来的版本中移除。它不再使用，可以安全地移除。输入示例不再被转换。

返回: 一个包含记录模型元数据的 ModelInfo 实例。

备注

实验性功能：此功能可能在未来的版本中无警告地更改或移除。

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

参数:

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使用指南 <https://mlflow.org/docs/latest/model/dependencies.html?highlight=code_paths#saving-extra-code-with-an-mlflow-model>`_。
mlflow_model – mlflow.models.Model 正在添加此风格。
signature – 一个 ModelSignature 类的实例，描述了模型的输入和输出。如果没有指定但提供了 input_example，将根据提供的输入示例和模型自动推断签名。要在提供输入示例时禁用自动签名推断，请将 signature 设置为 False。要手动推断模型签名，请在具有有效模型输入（例如省略了目标列的训练数据集）和有效模型输出（例如在训练数据集上进行的模型预测）的数据集上调用 infer_signature()，例如：
input_example – 一个或多个有效的模型输入实例。输入示例用作提示，指示应向模型提供哪些数据。它将被转换为Pandas DataFrame，然后使用Pandas的面向分割的格式序列化为json，或者是一个numpy数组，其中示例将通过将其转换为列表来序列化为json。字节被base64编码。当``signature``参数为``None``时，输入示例用于推断模型签名。
pip_requirements – 可以是 pip 需求字符串的可迭代对象（例如 ["promptflow", "-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 需求。
metadata – 传递给模型并在 MLmodel 文件中存储的自定义元数据字典。
model_config – 在推理过程中可以应用于流程实例的有效覆盖字典。这些参数仅用于将模型作为 pyfunc 模型加载的情况。这些值不会应用于从 mlflow.promptflow.load_model() 调用返回的流程。要覆盖带有 promptflow 风格的已加载流程的配置，请直接更新 pf_model.context。可以覆盖的配置包括： connection_provider - 用于流程的连接提供者。访问 https://microsoft.github.io/promptflow/how-to-guides/set-global-configs.html#connection-provider 了解更多关于如何设置连接提供者的详细信息。 connection_overrides - 用于流程的连接名称覆盖。示例： {"aoai_connection": "azure_open_ai_connection"}。引用连接 ‘aoai_connection’ 的节点将被解析为实际连接 ‘azure_open_ai_connection’。提供覆盖以使用 Azure 机器学习工作区连接的模型示例： .. code-block:: python 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, artifact_path=”promptflow_model”, model_config=model_config )
example_no_conversion – 此参数已被弃用，并将在未来的版本中移除。它不再使用，可以安全地移除。输入示例不再被转换。