HyperDriveRunConfig 类

定义 HyperDrive 运行的配置。

配置包括有关参数空间采样、终止策略、主要指标、估计器和执行运行试验的计算目标的信息。

初始化 HyperDriveConfig。

继承
azureml.train.hyperdrive.runconfig.HyperDriveConfig
HyperDriveRunConfig

构造函数

HyperDriveRunConfig(estimator, hyperparameter_sampling, primary_metric_name, primary_metric_goal, max_total_runs, max_concurrent_runs=None, max_duration_minutes=10080, policy=None)

参数

名称 说明
hyperparameter_sampling
必需

超参数采样空间。

primary_metric_name
必需
str

试验运行报告的主要指标的名称。

primary_metric_goal
必需

最大化/最小化之一。 它确定在试验运行评估中是否必须最小化/最大化主要指标。

max_total_runs
必需
int

最大运行数。 这是上限;当样本空间小于此值时,运行可能更少。

max_concurrent_runs
int

可以并发运行的最大运行数。 如果为 None,则并行启动所有运行。

默认值: None
max_duration_minutes
int

hyperdrive 运行的最长持续时间。 超过此时间后,将取消运行。 通过 ScriptRunConfig 的“max_run_duration_seconds”参数可以设置子运行的最长持续时间。

默认值: 10080
policy

要使用的提前终止策略。 如果为 None (默认值),则不会使用任何提前终止策略。 delay_evaluation 为 5 的 MedianTerminationPolicy 是一个很适合用作起点的终止策略。 这属于保守的设置,可以提供大约 25%-35% 的节省,且不会造成主要指标损失(基于我们的评估数据)。

默认值: None
estimator
必需

使用采样的超参数调用的估算器。

run_config
必需

用于设置脚本/笔记本运行的配置的对象。 仅指定以下参数之一:estimatorrun_configpipeline

resume_from
必需

一个 hyperdrive 运行,或 hyperdrive 运行列表,作为数据点继承以热启动新的运行。

resume_child_runs
必需
Runlist[Run]

一个 hyperdrive 子运行,或 hyperdrive 子运行列表,作为新 hyperdrive 运行的新子运行恢复。

pipeline
必需

用于设置管道运行配置的管道对象。 将使用示例超参数调用管道对象以提交管道运行。 仅指定以下参数之一:estimatorrun_configpipeline

hyperparameter_sampling
必需

超参数空间采样定义。

primary_metric_name
必需
str

试验运行报告的主要指标的名称。

primary_metric_goal
必需

PrimaryMetricGoal.MINIMIZE 或 PrimaryMetricGoal.MAXIMIZE。 此参数确定在评估运行时,是要最小化还是最大化主要指标。

max_total_runs
必需
int

要创建的运行的最大总数。 这是上限;当样本空间小于此值时,运行可能会更少。

max_concurrent_runs
必需
int

可以并发执行的最大运行数。 如果为 None,则并行启动所有运行。

max_duration_minutes
必需
int

HyperDrive 运行的最长持续时间。 超过此时间后,仍在执行的任何运行都会被取消。

policy
必需

要使用的提前终止策略。 如果为 None (默认值),则不会使用任何提前终止策略。

delay_evaluation 为 5 的 <xref:azureml.train.hyperdrive.MedianTerminationPolicy> 是一种良好的终止策略,可以从其开始。 这属于保守的设置,可以提供大约 25%-35% 的节省,且不会造成主要指标损失(基于我们的评估数据)。

estimator
必需

使用采样的超参数调用的估算器。 仅指定以下参数之一:estimatorrun_configpipeline

run_config
必需

用于设置脚本/笔记本运行的配置的对象。 仅指定以下参数之一:estimatorrun_configpipeline

resume_from
必需

一个 hyperdrive 运行,或 hyperdrive 运行列表,作为数据点继承以热启动新的运行。

resume_child_runs
必需
Run | list[Run]

一个 hyperdrive 子运行,或 hyperdrive 子运行列表,作为新 hyperdrive 运行的新子运行恢复。

pipeline
必需

用于设置管道运行配置的管道对象。 将使用示例超参数调用管道对象以提交管道运行。 仅指定以下参数之一:estimatorrun_configpipeline

custom_run_id
必需
str

用户提供的自定义运行 ID