HyperDriveConfig 類別

參考

定義 HyperDrive 執行的組態。

HyperDrive 設定包含超參數空間取樣、終止原則、主要計量、從設定、估算器和計算目標繼續執行實驗執行的相關資訊。

初始化 HyperDriveConfig。

繼承: builtins.object

HyperDriveConfig

建構函式

HyperDriveConfig(hyperparameter_sampling, primary_metric_name, primary_metric_goal, max_total_runs, max_concurrent_runs=None, max_duration_minutes=10080, policy=None, estimator=None, run_config=None, resume_from=None, resume_child_runs=None, pipeline=None, debug_flag=None, custom_run_id=None)

參數

名稱	Description
estimator	MMLBaseEstimator 使用取樣超參數呼叫的估算器。只指定下列其中一個參數： `estimator` 、 `run_config` 或 `pipeline` 。預設值: None
hyperparameter_sampling 必要	HyperParameterSampling 超參數取樣空間。
policy	EarlyTerminationPolicy 要使用的提早終止原則。如果為 None - 預設值，則不會使用任何提早終止原則。具有 MedianStoppingPolicy`delay_evaluation` 5 的是一個很好的終止原則，這些是保守的設定，可根據我們的評估資料) ，為主要計量 (節省 25%-35% 的費用。預設值: None
primary_metric_name 必要	str 實驗執行所報告的主要計量名稱。
primary_metric_goal 必要	PrimaryMetricGoal PrimaryMetricGoal.MINIMIZE 或 PrimaryMetricGoal.MAXIMIZE。此參數會判斷評估執行時，主要計量是否要最小化或最大化。
max_total_runs 必要	int 要建立的執行總數上限。這是上限;當樣本空間小於此值時，可能會有較少的執行。如果同時指定 `max_total_runs` 和 `max_duration_minutes`，在達到這兩個閾值的第一個時，就會終止超參數微調實驗。
max_concurrent_runs	int 要同時執行的執行數目上限。如果為 None，則會以平行方式啟動所有執行。同時執行之數目會受限於指定計算目標中的可用資源。因此，您必須確保計算目標有資源可用於所需的並行作業。預設值: None
max_duration_minutes	int HyperDrive 執行的持續時間上限。超過此時間之後，任何仍在執行的執行都會取消。如果同時指定 `max_total_runs` 和 `max_duration_minutes`，在達到這兩個閾值的第一個時，就會終止超參數微調實驗。預設值: 10080
resume_from	HyperDriveRun 或 list[HyperDriveRun] Hyperdrive 執行或 hyperdrive 執行清單，這些執行會繼承為資料點，以暖啟動新的執行。預設值: None
resume_child_runs	Run 或 list[Run] Hyperdrive 子執行或 hyperdrive 子執行清單，當新 Hyperdrive 執行的新子執行時，將會繼續執行。預設值: None
run_config	ScriptRunConfig 物件，用於設定腳本/筆記本執行的組態。只指定下列其中一個參數： `estimator` 、 `run_config` 或 `pipeline` 。預設值: None
pipeline	Pipeline 用於設定管線執行組態的管線物件。管線物件將會使用範例超參數呼叫，以提交管線執行。只指定下列其中一個參數： `estimator` 、 `run_config` 或 `pipeline` 。預設值: None
custom_run_id	str 使用者提供的自訂執行識別碼預設值: None
hyperparameter_sampling 必要	HyperParameterSampling 超參數空間取樣定義。
primary_metric_name 必要	str 實驗執行所報告的主要計量名稱。
primary_metric_goal 必要	PrimaryMetricGoal PrimaryMetricGoal.MINIMIZE 或 PrimaryMetricGoal.MAXIMIZE。此參數會判斷評估執行時，主要計量是否要最小化或最大化。
max_total_runs 必要	int 要建立的執行總數上限。這是上限;當樣本空間小於此值時，可能會有較少的執行。
max_concurrent_runs 必要	int 要同時執行的執行數目上限。如果為 None，則會以平行方式啟動所有執行。
max_duration_minutes 必要	int HyperDrive 執行的持續時間上限。超過此時間之後，任何仍在執行的執行都會取消。
policy 必要	EarlyTerminationPolicy 要使用的提早終止原則。如果為 None - 預設值，則不會使用任何提早終止原則。具有 <xref:azureml.train.hyperdrive.MedianTerminationPolicy>`delay_evaluation` 5 的是一個很好的終止原則，這些是保守的設定，可根據我們的評估資料) ，為主要計量 (節省 25%-35% 的費用。
estimator 必要	MMLBaseEstimator 使用取樣的超參數呼叫的估算器。只指定下列其中一個參數： `estimator` 、 `run_config` 或 `pipeline` 。
run_config 必要	ScriptRunConfig 物件，用於設定腳本/筆記本執行的組態。只指定下列其中一個參數： `estimator` 、 `run_config` 或 `pipeline` 。
resume_from 必要	HyperDriveRun \| list[HyperDriveRun] Hyperdrive 執行或 hyperdrive 執行清單，這些執行會繼承為資料點，以暖啟動新的執行。
resume_child_runs 必要	Run \| list[Run] Hyperdrive 子執行或 hyperdrive 子執行清單，當新 Hyperdrive 執行的新子執行時，將會繼續執行。
pipeline 必要	Pipeline 用於設定管線執行組態的管線物件。管線物件將會使用範例超參數呼叫，以提交管線執行。只指定下列其中一個參數： `estimator` 、 `run_config` 或 `pipeline` 。
custom_run_id 必要	str 使用者提供的自訂執行識別碼
debug_flag	預設值: None

備註

下列範例示範如何建立要用於超參數微調的 HyperDriveConfig 物件。在此範例中，主要計量名稱會比對定型腳本中記錄的值。


   hd_config = HyperDriveConfig(run_config=src,
                    hyperparameter_sampling=ps,
                    policy=early_termination_policy,
                    primary_metric_name='validation_acc',
                    primary_metric_goal=PrimaryMetricGoal.MAXIMIZE,
                    max_total_runs=4,
                    max_concurrent_runs=4)

如需使用 HyperDriveConfig 的詳細資訊，請參閱微調模型的超參數教學課程。

屬性

estimator

傳回 HyperDrive 執行中使用的估算器。

如果執行使用腳本執行組態或管線，則值為 None。

傳回

類型	Description
Estimator, None	估算器。

pipeline

傳回 HyperDrive 執行中使用的管線。

如果執行使用腳本執行組態或估算器，則值為 None。

傳回

類型	Description
Pipeline, None	管線。

run_config

傳回 HyperDrive 執行中使用的腳本/筆記本組態。

如果執行使用估算器或管線，則值為 None。

傳回

類型	Description
ScriptRunConfig, None	執行組態。

source_directory

從要執行的組態傳回來原始目錄。

傳回

類型	Description
str	來原始目錄

共用方式為