HyperDriveRun 類別

HyperDriveRun 包含提交之 HyperDrive 實驗的詳細資料。

這個類別可用來管理、檢查狀態，以及擷取 HyperDrive 回合的執行詳細資料，以及每個產生的子執行。

初始化 HyperDrive 執行。

繼承

Run

HyperDriveRun

建構函式

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

參數

名稱	Description
experiment 必要	Experiment HyperDrive 執行的實驗。
run_id 必要	str HyperDrive 執行識別碼。
hyperdrive_config	HyperDriveConfig 此 HyperDrive 的組態會執行。 預設值: None
experiment 必要	Experiment HyperDrive 執行的實驗。
run_id 必要	str HyperDrive 執行識別碼。
hyperdrive_config 必要	HyperDriveConfig 此 HyperDrive 的組態會執行。 如果為 None，我們假設執行已經存在，而且會嘗試從雲端凍結。

方法

cancel	如果 HyperDrive 執行成功取消，則傳回 True。
fail	請勿使用。 HyperDriveRun 子類別不支援 fail 方法。
get_best_run_by_primary_metric	尋找並傳回對應至所有子執行之間最佳執行執行的 Run 實例。 最佳執行只會根據 HyperDriveConfig 中指定的主要計量參數來識別。 PrimaryMetricGoal 會控管使用主要計量的最小值或最大值。 若要執行此 HyperDriveRun 所啟動之所有 ExperimentRun 計量的詳細分析，請使用 get_metrics。 即使此 HyperDrive 執行所啟動的數個執行達到相同的最佳計量，也會傳回其中一個執行。
get_children_sorted_by_primary_metric	傳回依其最佳主要計量排序的子系列表。 排序是根據主要計量及其目標來完成：如果其最大化，則子系會依最佳主要計量的遞減順序傳回。 如果 reverse 為 True，則順序會反轉。 結果中的每個子系都有執行識別碼、超參數、最佳主要計量值和狀態。 當discard_no_metric為 True 時，會捨棄沒有主要計量的子系。 否則，它們會附加至具有主要計量之其他子系後面的清單。 請注意，反向選項不會影響它們。
get_diagnostics	請勿使用。 HyperDriveRun 子類別不支援get_diagnostics方法。
get_hyperparameters	傳回這個 HyperDriveRun 所啟動之所有子回合的超參數。
get_metrics	從這個 HyperDriveRun 啟動的所有執行傳回計量。

cancel

如果 HyperDrive 執行成功取消，則傳回 True。

cancel()

傳回

類型	Description
bool	是否成功取消執行。

fail

請勿使用。 HyperDriveRun 子類別不支援 fail 方法。

fail()

例外狀況

類型	Description
HyperDriveNotImplementedException

get_best_run_by_primary_metric

尋找並傳回對應至所有子執行之間最佳執行執行的 Run 實例。

最佳執行只會根據 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

參數

名稱	Description
include_failed	bool 是否包含失敗的執行。 預設值: True
include_canceled	bool 是否包含已取消的執行。 預設值: True
include_resume_from_runs	bool 是否要包含繼承resume_from執行。 預設值: True

傳回

類型	Description
Run	最佳執行，如果沒有子系具有主要計量，則為 None。

get_children_sorted_by_primary_metric

傳回依其最佳主要計量排序的子系列表。

排序是根據主要計量及其目標來完成：如果其最大化，則子系會依最佳主要計量的遞減順序傳回。 如果 reverse 為 True，則順序會反轉。

結果中的每個子系都有執行識別碼、超參數、最佳主要計量值和狀態。

當discard_no_metric為 True 時，會捨棄沒有主要計量的子系。 否則，它們會附加至具有主要計量之其他子系後面的清單。 請注意，反向選項不會影響它們。

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

參數

名稱	Description
top	int 要傳回的最上層子係數目。 如果是 0，則會傳回所有子系。 預設值: 0
reverse	bool 如果為 True，則會反轉順序。 它只會影響具有主要計量的子系。 預設值: False
discard_no_metric	bool 如果為 False，則沒有主要計量的子系將會附加至清單。 預設值: False

傳回

類型	Description
list	具有執行識別碼、超參數、最佳主要計量和狀態的字典清單

get_diagnostics

請勿使用。 HyperDriveRun 子類別不支援get_diagnostics方法。

get_diagnostics()

例外狀況

類型	Description
HyperDriveNotImplementedException

get_hyperparameters

傳回這個 HyperDriveRun 所啟動之所有子回合的超參數。

get_hyperparameters()

傳回

類型	Description
dict	所有子執行的超參數。 它是run_id作為索引鍵的字典。

get_metrics

從這個 HyperDriveRun 啟動的所有執行傳回計量。

get_metrics()

傳回

類型	Description
dict	此執行之所有子系的計量。

屬性

hyperdrive_config

傳回 Hyperdrive 執行組態。

傳回

類型	Description
HyperDriveConfig	Hyperdrive 執行組態。

HYPER_DRIVE_RUN_USER_AGENT

HYPER_DRIVE_RUN_USER_AGENT = 'sdk_run_hyper_drive'

RUN_TYPE

RUN_TYPE = 'hyperdrive'