HyperDriveRun 类

HyperDriveRun 包含提交的 HyperDrive 试验的详细信息。

此类可用于管理、检查状态和检索 HyperDrive 运行和每个生成的子运行运行的运行详细信息。

初始化 HyperDrive 运行。

构造函数

HyperDriveRun(experiment, run_id, hyperdrive_config=None, **kwargs)

参数

名称 说明
experiment
必需

HyperDrive 运行的试验。

run_id
必需
str

HyperDrive 运行 ID。

hyperdrive_config

此 HyperDrive 运行的配置。

默认值: None
experiment
必需

HyperDrive 运行的试验。

run_id
必需
str

HyperDrive 运行 ID。

hyperdrive_config
必需

此 HyperDrive 运行的配置。 如果 None,我们假设运行已存在,并会尝试从云中解除冻结。

方法

cancel

如果 HyperDrive 运行已成功取消,则返回 True。

fail

请勿使用。 HyperDriveRun 子类不支持失败方法。

get_best_run_by_primary_metric

查找并返回与所有子运行中性能最佳的运行相对应的运行实例。

性能最佳的运行仅基于 HyperDriveConfig 中指定的主指标参数进行标识。 PrimaryMetricGoal 控制使用主指标的最小值还是最大值。 若要对此 HyperDriveRun 启动的所有 ExperimentRun 指标执行更详细的分析,请使用get_metrics。 仅返回其中一个运行,即使此 HyperDrive 运行启动的多个运行达到相同的最佳指标也是如此。

get_children_sorted_by_primary_metric

返回按最佳主要指标排序的子级列表。

排序是根据主要指标及其目标完成的:如果它是最大化的,则子级按其最佳主要指标的降序返回。 如果反向为 True,则顺序将反转。

结果中的每个子级都有运行 ID、超参数、最佳主要指标值和状态。

当 discard_no_metric 为 True 时,将丢弃没有主要指标的子级。 否则,它们将追加到具有主要指标的其他子级后面的列表中。 请注意,反向选项不会影响它们。

get_diagnostics

请勿使用。 HyperDriveRun 子类不支持get_diagnostics方法。

get_hyperparameters

返回此 HyperDriveRun 启动的所有子运行的超参数。

get_metrics

返回此 HyperDriveRun 启动的所有运行中的指标。

cancel

如果 HyperDrive 运行已成功取消,则返回 True。

cancel()

返回

类型 说明

是否成功取消运行。

fail

请勿使用。 HyperDriveRun 子类不支持失败方法。

fail()

例外

类型 说明

get_best_run_by_primary_metric

查找并返回与所有子运行中性能最佳的运行相对应的运行实例。

性能最佳的运行仅基于 HyperDriveConfig 中指定的主指标参数进行标识。 PrimaryMetricGoal 控制使用主指标的最小值还是最大值。 若要对此 HyperDriveRun 启动的所有 ExperimentRun 指标执行更详细的分析,请使用get_metrics。 仅返回其中一个运行,即使此 HyperDrive 运行启动的多个运行达到相同的最佳指标也是如此。

get_best_run_by_primary_metric(include_failed=True, include_canceled=True, include_resume_from_runs=True) -> Run | None

参数

名称 说明
include_failed

是否包括失败的运行。

默认值: True
include_canceled

是否包括已取消的运行。

默认值: True
include_resume_from_runs

是否包括继承resume_from运行。

默认值: True

返回

类型 说明
Run

最佳运行,如果没有子级具有主要指标,则为 None。

get_children_sorted_by_primary_metric

返回按最佳主要指标排序的子级列表。

排序是根据主要指标及其目标完成的:如果它是最大化的,则子级按其最佳主要指标的降序返回。 如果反向为 True,则顺序将反转。

结果中的每个子级都有运行 ID、超参数、最佳主要指标值和状态。

当 discard_no_metric 为 True 时,将丢弃没有主要指标的子级。 否则,它们将追加到具有主要指标的其他子级后面的列表中。 请注意,反向选项不会影响它们。

get_children_sorted_by_primary_metric(top=0, reverse=False, discard_no_metric=False)

参数

名称 说明
top
int

要返回的顶级子级数。 如果为 0,将返回所有子级。

默认值: 0
reverse

如果为 True,则顺序将反转。 它只影响具有主要指标的子级。

默认值: False
discard_no_metric

如果为 False,则不带主指标的子级将追加到列表中。

默认值: False

返回

类型 说明

运行 ID、超参数、最佳主要指标和状态的字典列表

get_diagnostics

请勿使用。 HyperDriveRun 子类不支持get_diagnostics方法。

get_diagnostics()

例外

类型 说明

get_hyperparameters

返回此 HyperDriveRun 启动的所有子运行的超参数。

get_hyperparameters()

返回

类型 说明

所有子运行的超参数。 它是run_id作为键的字典。

get_metrics

返回此 HyperDriveRun 启动的所有运行中的指标。

get_metrics()

返回

类型 说明

此运行的所有子级的指标。

属性

hyperdrive_config

返回 hyperdrive 运行配置。

返回

类型 说明

hyperdrive 运行配置。

HYPER_DRIVE_RUN_USER_AGENT

HYPER_DRIVE_RUN_USER_AGENT = 'sdk_run_hyper_drive'

RUN_TYPE

RUN_TYPE = 'hyperdrive'