ParallelRunConfig 类

定义对象的配置 ParallelRunStep 。

有关使用 ParallelRunStep 的示例，请参阅笔记本 https://aka.ms/batch-inference-notebooks。

有关故障排除指南，请参阅 https://aka.ms/prstsg。你可以在此处找到更多引用。

初始化配置对象。

构造函数

ParallelRunConfig(environment, entry_script, error_threshold, output_action, compute_target, node_count, process_count_per_node=None, mini_batch_size=None, source_directory=None, description=None, logging_level='INFO', run_invocation_timeout=60, run_max_try=3, append_row_file_name=None, allowed_failed_count=None, allowed_failed_percent=None, partition_keys=None, environment_variables=None)

参数

名称	说明
environment 必需	Environment 配置 Python 环境的环境定义。可以将它配置为使用现有 Python 环境，或设置试验的临时环境。环境定义负责定义所需的应用程序依赖项，例如 conda 或 pip 包。
entry_script 必需	str 将在多个节点上并行运行的用户脚本。这指定为本地文件路径。如果 `source_directory` 指定，则 `entry_script` 为目录中的相对路径。否则，它可以是计算机上可访问的任何路径。 entry_script应包含两个函数： `init()`此函数应用于任何成本高昂或常见准备的后续推理，例如反序列化模型并将其加载到全局对象中。 `run(mini_batch)`：要并行化的方法。每个调用都有一个小型批处理。 “mini_batch”：批处理推理将调用运行方法，并将列表或 Pandas DataFrame 作为参数传递给该方法。如果输入为 FileDataset，则min_batch中的每个条目都是文件路径，如果输入为 TabularDataset，则为 Pandas 数据帧。 run（）方法应返回 Pandas 数据帧或数组。对于 append_row output_action，这些返回的元素将追加到公共输出文件中。对于 summary_only，将忽略元素的内容。对于所有输出作，每个返回的输出元素都指示输入微型批处理中输入元素的一次成功推理。每个并行工作进程都会调用 init 一次，然后循环访问运行函数，直到处理所有微型批处理。
error_threshold 必需	int 处理过程中应忽略记录失败 TabularDataset 次数和文件失败 FileDataset 次数。如果错误计数高于此值，则将中止作业。错误阈值适用于整个输入，而不是针对发送到 run（）方法的单个小型批处理。范围为 [-1， int.max]。 -1 表示在处理过程中忽略所有失败。
output_action 必需	str 应如何组织输出。当前支持的值是“append_row”和“summary_only”。 “append_row” – run（）方法调用输出的所有值将聚合到一个名为 parallel_run_step.txt 的唯一文件中，该文件在输出位置创建。 “summary_only” - 用户脚本应存储输出本身。处理的每个成功输入项仍需要输出行。系统仅将此输出用于错误阈值计算（忽略行的实际值）。
compute_target 必需	AmlCompute 或 str 用于 ParallelRunStep 执行的计算目标。此参数可以指定为计算目标对象或工作区中的计算目标的名称。
node_count 必需	int 用于运行 ParallelRunStep 的计算目标中的节点数。
process_count_per_node	int 每个节点并行运行入口脚本的工作进程数。对于 GPU 计算机，默认值为 1。对于 CPU 计算机，默认值为核心数。工作进程会通过传递它获取的微型批来反复调用 `run()`。作业中的工作进程总数为 `process_count_per_node * node_count`，这个数字决定了要并行执行的 `run()` 的最大数目。默认值: None
mini_batch_size	Union[str, int] 对于 FileDataset 输入，此字段是用户脚本可以在一次 run（）调用中处理的文件数。对于 TabularDataset 输入，此字段是用户脚本可以在一次 run（）调用中处理的大致数据大小。示例值为 1024、1024KB、10MB 和 1GB。（可选，对于 FileDataset，默认值为 10 个文件，对于 TabularDataset 为 1MB）。默认值: None
source_directory	str 包含 `entry_script` 用于在计算目标上执行的支持文件的文件夹的路径。默认值: None
description	str 为用于显示目的的批处理服务提供说明。默认值: None
logging_level	str 日志记录级别名称的字符串，该名称在“logging”中定义。可能的值为“WARNING”、“INFO”和“DEBUG”。（可选，默认值为“INFO”。）默认值: INFO
run_invocation_timeout	int 每次调用 run（）方法的超时（以秒为单位）。（可选，默认值为 60。默认值: 60
run_max_try	int 失败或超时迷你批的最大尝试次数。范围为 [1， int.max]。默认值为 3。取消排队计数大于此计数的小型批处理不会再次处理，并且将直接删除。默认值: 3
append_row_file_name	str 输出文件的名称（如果 `output_action` 为“append_row”。（可选，默认值为“parallel_run_step.txt”）默认值: None
allowed_failed_count	int 在处理过程中应忽略的失败小型批数。如果失败的计数超过此值，作业将中止。此阈值适用于整个输入，而不是发送到 run（）方法的单个小型批处理。范围为 [-1， int.max]。 -1 表示在处理过程中忽略所有失败。小型批处理可能会在第一次处理时失败，然后在第二次尝试中成功。第一次和第二次检查会将其计为失败。第二次检查不会将其计为失败。参数 -error_threshold、–allowed_failed_count 和 –allowed_failed_percent可以协同工作。如果指定了多个作业，则作业将中止（如果超过其中任何一个）。默认值: None
allowed_failed_percent	float 在处理过程中应忽略的失败小型批处理的百分比。如果失败百分比高于此值，则将中止作业。此阈值适用于整个输入，而不是发送到 run（）方法的单个小型批处理。范围为 [0， 100]。 100 或 100.0 表示在处理过程中忽略所有失败。检查在计划所有小型批处理后开始。参数 -error_threshold、–allowed_failed_count 和 –allowed_failed_percent可以协同工作。如果指定了多个作业，则作业将中止（如果超过其中任何一个）。默认值: None
partition_keys	List[str] 用于将数据集分区为小型批处理的键。如果指定此参数，则具有相同键的数据将分区到相同的小型批处理中。如果同时指定了partition_keys和mini_batch_size，则会引发错误。它应该是用于对输入数据集进行分区的键的 str 元素列表。但是，如果提升到 PipelineParameter，则默认值应为列表的 json 转储 str，因为目前 PipelineParameter 不支持列表类型。输入必须分区数据集（s），partition_keys必须是每个输入数据集的键子集才能正常工作。默认值: None
environment_variables	Dict[str, str] 环境变量名称和值的字典。这些环境变量是在执行用户脚本的进程上设置的。默认值: None
environment 必需	Environment 配置 Python 环境的环境定义。可以将它配置为使用现有 Python 环境，或设置试验的临时环境。环境定义负责定义所需的应用程序依赖项，例如 conda 或 pip 包。
entry_script 必需	str 将在多个节点上并行运行的用户脚本。这指定为本地文件路径。如果 `source_directory` 指定，则 `entry_script` 为目录中的相对路径。否则，它可以是计算机上可访问的任何路径。 entry_script应包含两个函数： `init()`此函数应用于任何成本高昂或常见准备的后续推理，例如反序列化模型并将其加载到全局对象中。 `run(mini_batch)`：要并行化的方法。每个调用都有一个小型批处理。 “mini_batch”：批处理推理将调用运行方法，并将列表或 Pandas DataFrame 作为参数传递给该方法。如果输入为 FileDataset，则min_batch中的每个条目都是文件路径，如果输入为 TabularDataset，则为 Pandas 数据帧。 run（）方法应返回 Pandas 数据帧或数组。对于 append_row output_action，这些返回的元素将追加到公共输出文件中。对于 summary_only，将忽略元素的内容。对于所有输出作，每个返回的输出元素都指示输入微型批处理中输入元素的一次成功推理。每个并行工作进程都会调用 init 一次，然后循环访问运行函数，直到处理所有微型批处理。
error_threshold 必需	int 处理过程中应忽略记录失败 TabularDataset 次数和文件失败 FileDataset 次数。如果错误计数高于此值，则将中止作业。错误阈值适用于整个输入，而不是针对发送到 run（）方法的单个小型批处理。范围为 [-1， int.max]。 -1 表示在处理过程中忽略所有失败。
output_action 必需	str 应如何组织输出。当前支持的值是“append_row”和“summary_only”。 “append_row” – run（）方法调用输出的所有值将聚合到一个名为 parallel_run_step.txt 的唯一文件中，该文件在输出位置创建。 “summary_only” - 用户脚本应存储输出本身。处理的每个成功输入项仍需要输出行。系统仅将此输出用于错误阈值计算（忽略行的实际值）。
compute_target 必需	AmlCompute 或 str 用于 ParallelRunStep 执行的计算目标。此参数可以指定为计算目标对象或工作区中的计算目标的名称。
node_count 必需	int 用于运行 ParallelRunStep 的计算目标中的节点数。
process_count_per_node 必需	int 每个节点并行运行入口脚本的工作进程数。对于 GPU 计算机，默认值为 1。对于 CPU 计算机，默认值为核心数。工作进程会通过传递它获取的微型批来反复调用 `run()`。作业中的工作进程总数为 `process_count_per_node * node_count`，这个数字决定了要并行执行的 `run()` 的最大数目。
mini_batch_size 必需	str 或 int 对于 FileDataset 输入，此字段是用户脚本可以在一次 run（）调用中处理的文件数。对于 TabularDataset 输入，此字段是用户脚本可以在一次 run（）调用中处理的大致数据大小。示例值为 1024、1024KB、10MB 和 1GB。（可选，对于 FileDataset，默认值为 10 个文件，对于 TabularDataset 为 1MB）。
source_directory 必需	str 包含 `entry_script` 用于在计算目标上执行的支持文件的文件夹的路径。
description 必需	str 为用于显示目的的批处理服务提供说明。
logging_level 必需	str 日志记录级别名称的字符串，该名称在“logging”中定义。可能的值为“WARNING”、“INFO”和“DEBUG”。（可选，默认值为“INFO”。）
run_invocation_timeout 必需	int 每次调用 run（）方法的超时（以秒为单位）。（可选，默认值为 60。
run_max_try 必需	int 失败或超时迷你批的最大尝试次数。范围为 [1， int.max]。默认值为 3。取消排队计数大于此计数的小型批处理不会再次处理，并且将直接删除。
append_row_file_name 必需	str 输出文件的名称（如果 `output_action` 为“append_row”。（可选，默认值为“parallel_run_step.txt”）
allowed_failed_count 必需	int 在处理过程中应忽略的失败小型批数。如果失败的计数超过此值，作业将中止。此阈值适用于整个输入，而不是发送到 run（）方法的单个小型批处理。范围为 [-1， int.max]。 -1 表示在处理过程中忽略所有失败。小型批处理可能会在第一次处理时失败，然后在第二次尝试中成功。第一次和第二次检查会将其计为失败。第二次检查不会将其计为失败。参数 -error_threshold、–allowed_failed_count 和 –allowed_failed_percent可以协同工作。如果指定了多个作业，则作业将中止（如果超过其中任何一个）。
allowed_failed_percent 必需	float 在处理过程中应忽略的失败小型批处理的百分比。如果失败百分比高于此值，则将中止作业。此阈值适用于整个输入，而不是发送到 run（）方法的单个小型批处理。范围为 [0， 100]。 100 或 100.0 表示在处理过程中忽略所有失败。检查在计划所有小型批处理后开始。参数 -error_threshold、–allowed_failed_count 和 –allowed_failed_percent可以协同工作。如果指定了多个作业，则作业将中止（如果超过其中任何一个）。
partition_keys 必需	List[str] 用于将数据集分区为小型批处理的键。如果指定此参数，则具有相同键的数据将分区到相同的小型批处理中。如果同时指定了partition_keys和mini_batch_size，则会引发错误。它应该是用于对输入数据集进行分区的键的 str 元素列表。但是，如果提升到 PipelineParameter，则默认值应为列表的 json 转储 str，因为目前 PipelineParameter 不支持列表类型。输入必须分区数据集（s），partition_keys必须是每个输入数据集的键子集才能正常工作。
environment_variables 必需	Dict[str, str] 环境变量名称和值的字典。这些环境变量是在执行用户脚本的进程上设置的。

注解

ParallelRunConfig 类用于提供类 ParallelRunStep 的配置。 ParallelRunConfig 和 ParallelRunStep 可用于并行处理大量数据。常见的用例是训练 ML 模型或运行脱机推理，以根据一批观察数据来生成预测。 ParallelRunStep 的工作原理是将数据分解成并行处理的批处理。可以使用类控制 ParallelRunConfig 批大小、节点计数和其他可加速并行处理的参数。 ParallelRunStep 可以使用任一或TabularDataset FileDataset作为输入。

使用 ParallelRunStep 和 ParallelRunConfig：

创建一个 ParallelRunConfig 对象，以指定批处理的执行方式、用于控制批大小的参数、每个计算目标的节点数以及对自定义 Python 脚本的引用。
创建使用 ParallelRunConfig 对象的 ParallelRunStep 对象，定义步骤的输入和输出。
像使用其他管道步骤类型一 Pipeline 样，使用配置的 ParallelRunStep 对象。

以下文章介绍了如何使用 ParallelRunStep 和 ParallelRunConfig 类进行批处理推理的示例：

教程：生成用于批量评分的 Azure 机器学习管道。本文介绍如何在管道中将这两个类用于异步批评分，并使 REST 终结点能够运行管道。
使用 Azure 机器学习对大量数据运行批处理推理。本文介绍如何通过自定义推理脚本和 MNIST 数据集上预先训练的图像分类模型库以异步和并行方式处理大量数据。


   from azureml.pipeline.steps import ParallelRunStep, ParallelRunConfig

   parallel_run_config = ParallelRunConfig(
       source_directory=scripts_folder,
       entry_script=script_file,
       mini_batch_size="5",        # or partition_keys=["key1", "key2"], which is another way to partition the
                                   # input to mini-batches, refer to the parameter description for details
       error_threshold=10,         # Optional, allowed failed count on mini batch items
       allowed_failed_count=15,    # Optional, allowed failed count on mini batches
       allowed_failed_percent=10,  # Optional, allowed failed percent on mini batches
       run_max_try=3,
       output_action="append_row",
       environment=batch_env,
       compute_target=compute_target,
       node_count=2)

   parallelrun_step = ParallelRunStep(
       name="predict-digits-mnist",
       parallel_run_config=parallel_run_config,
       inputs=[ named_mnist_ds ],
       output=output_dir,
       arguments=[ "--extra_arg", "example_value" ],
       allow_reuse=True
   )

有关此示例的详细信息，请参阅笔记本 https://aka.ms/batch-inference-notebooks。

方法

load_yaml	从 YAML 文件加载并行运行配置数据。
save_to_yaml	将并行运行配置数据导出到 YAML 文件。

load_yaml

从 YAML 文件加载并行运行配置数据。

static load_yaml(workspace, path)

参数

名称	说明
workspace 必需	Workspace 要从中读取配置数据的工作区。
path 必需	str 从中加载配置的路径。

save_to_yaml

将并行运行配置数据导出到 YAML 文件。

save_to_yaml(path)

参数

名称	说明
path 必需	str 要保存文件的路径。

通过

ParallelRunConfig 类

构造函数

参数

注解

方法

load_yaml

参数

save_to_yaml

参数

反馈