HyperDriveRun 类

参考

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

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

初始化 HyperDrive 运行。

继承: Run

HyperDriveRun

构造函数

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

参数

名称	说明
experiment 必需	Experiment HyperDrive 运行的试验。
run_id 必需	str HyperDrive 运行 ID。
hyperdrive_config	HyperDriveConfig 此 HyperDrive 运行的配置。默认值: None
experiment 必需	Experiment HyperDrive 运行的试验。
run_id 必需	str HyperDrive 运行 ID。
hyperdrive_config 必需	HyperDriveConfig 此 HyperDrive 运行的配置。如果“无”，则假定运行已存在，并尝试从云中水合。

方法

cancel	如果 HyperDrive 运行已成功取消，则返回 True。
fail	请勿使用。 HyperDriveRun 子类不支持 fail 方法。
get_best_run_by_primary_metric	查找并返回与所有子运行中性能最佳的运行相对应的运行实例。性能最佳的运行只基于 HyperDriveConfig 中指定的主要指标参数来识别。 PrimaryMetricGoal 控制是否使用主要指标的最小值或最大值。若要对此 HyperDriveRun 启动的所有 ExperimentRun 指标进行更详细的分析，请使用 get_metrics。即使此 HyperDrive 运行启动的几个运行达到相同的最佳指标，也仅返回其中一个运行。
get_children_sorted_by_primary_metric	返回按最佳主要指标排序的子级列表。排序根据主要指标及其目标完成：如果是最大化，则子级按其最佳主要指标的降序返回。如果 reverse 为 True，则顺序反转。结果中的每个子级都有运行 ID、超参数、最佳主要指标值和状态。当 discard_no_metric 为 True 时，将放弃没有主要指标的子级。否则，它们将被追加到具有主要指标的其他子级后面的列表中。请注意，反转选项对它们没有影响。
get_diagnostics	请勿使用。 HyperDriveRun 子类不支持 get_diagnostics 方法。
get_hyperparameters	返回此 HyperDriveRun 启动的所有子运行的超参数。
get_metrics	返回此 HyperDriveRun 启动的所有运行中的指标。

cancel

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

cancel()

类型	说明
bool	运行是否已成功取消。

fail

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

fail()

例外

类型	说明
HyperDriveNotImplementedException

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	bool 是否包括失败的运行。默认值: True
include_canceled	bool 是否包括已取消的运行。默认值: True
include_resume_from_runs	bool 是否包括继承的 resume_from 运行。默认值: True

类型	说明
Run	最佳运行，如果没有子级具有主要指标，则为 None。

get_children_sorted_by_primary_metric

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

排序根据主要指标及其目标完成：如果是最大化，则子级按其最佳主要指标的降序返回。如果 reverse 为 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	bool 如果为 True，则顺序将反转。它仅影响具有主要指标的子级。默认值: False
discard_no_metric	bool 如果为 False，则没有主要指标的子级将被追加到列表中。默认值: False

类型	说明
list	包含运行 ID、超参数、最佳主要指标和状态的字典列表

get_diagnostics

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

get_diagnostics()

例外

类型	说明
HyperDriveNotImplementedException

get_hyperparameters

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

get_hyperparameters()

类型	说明
dict	所有子运行的超参数。它是以 run_id 作为键的字典。

get_metrics

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

get_metrics()

类型	说明
dict	此运行的所有子级的指标。

属性

hyperdrive_config

返回 hyperdrive 运行配置。

类型	说明
HyperDriveConfig	hyperdrive 运行配置。

HYPER_DRIVE_RUN_USER_AGENT

HYPER_DRIVE_RUN_USER_AGENT = 'sdk_run_hyper_drive'

RUN_TYPE

RUN_TYPE = 'hyperdrive'