HyperDriveConfig クラス
HyperDrive の実行を定義する構成。
HyperDrive の構成には、ハイパーパラメーター空間サンプリング、終了ポリシー、プライマリ メトリック、構成からの再開、推定器、実験の実行を実行するコンピューティング先に関する情報が含まれています。
HyperDriveConfig を初期化します。
- 継承
-
builtins.objectHyperDriveConfig
コンストラクター
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)
パラメーター
名前 | 説明 |
---|---|
estimator
|
サンプリングされたハイパーパラメーターを使用して呼び出される推定器。
規定値: None
|
hyperparameter_sampling
必須
|
ハイパーパラメーターのサンプリング空間 |
policy
|
使用する早期終了ポリシー。 None (既定値) の場合、早期終了ポリシーは使用されません。
MedianStoppingPolicy で 規定値: None
|
primary_metric_name
必須
|
実験の実行によって報告された主要メトリックの名前。 |
primary_metric_goal
必須
|
PrimaryMetricGoal.MINIMIZE または PrimaryMetricGoal.MAXIMIZE のいずれかです。 このパラメーターは、実行の評価時にプライマリ メトリックを最小化するか最大化するかを決定します。 |
max_total_runs
必須
|
作成する実行の最大総数。 これは上限です。サンプル空間がこの値より小さい場合は、実行回数が少なくなる可能性があります。
|
max_concurrent_runs
|
同時に実行できる実行の最大数。 None の場合、すべての実行が並列で起動されます。 並列実行の数は、指定された計算ターゲットで使用できるリソースに基づいて制御されます。 そのため、目的の同時実行可能性のために、計算ターゲットに必要なリソースを確保する必要があります。 規定値: None
|
max_duration_minutes
|
HyperDrive の実行の最大継続時間。 この時間を超えると、実行中の実行は取り消されます。
規定値: 10080
|
resume_from
|
ハイパードライブ実行、または新しい実行をウォーム スタートするためのデータ ポイントとして継承されるハイパードライブ実行の一覧。 規定値: None
|
resume_child_runs
|
ハイパードライブの子実行、または新しいハイパードライブ実行の新しい子実行として再開されるハイパードライブの子実行の一覧。 規定値: None
|
run_config
|
スクリプト/ノートブック実行の構成を設定するオブジェクト。
規定値: None
|
pipeline
|
パイプライン実行の構成を設定するパイプライン オブジェクト。
パイプライン オブジェクトは、パイプラインの実行を送信するためにサンプルのハイパーパラメーターを使用して呼び出されます。
規定値: None
|
custom_run_id
|
ユーザーが提供するカスタム実行 ID 規定値: None
|
hyperparameter_sampling
必須
|
ハイパーパラメーター空間サンプリング定義。 |
primary_metric_name
必須
|
実験の実行によって報告された主要メトリックの名前。 |
primary_metric_goal
必須
|
PrimaryMetricGoal.MINIMIZE または PrimaryMetricGoal.MAXIMIZE のいずれかです。 このパラメーターは、実行の評価時にプライマリ メトリックを最小化するか最大化するかを決定します。 |
max_total_runs
必須
|
作成する実行の最大総数。 これは上限です。サンプル空間がこの値より小さい場合は、実行回数が少なくなる可能性があります。 |
max_concurrent_runs
必須
|
同時に実行できる実行の最大数。 None の場合、すべての実行が並列で起動されます。 |
max_duration_minutes
必須
|
HyperDrive の実行の最大継続時間。 この時間を超えると、実行中の実行は取り消されます。 |
policy
必須
|
使用する早期終了ポリシー。 None (既定値) の場合、早期終了ポリシーは使用されません。
<xref:azureml.train.hyperdrive.MedianTerminationPolicy> で |
estimator
必須
|
サンプリングされたハイパー パラメーターを使用して呼び出される推定器。
|
run_config
必須
|
スクリプト/ノートブック実行の構成を設定するオブジェクト。
|
resume_from
必須
|
ハイパードライブの実行、または新しい実行をウォーム スタートするためのデータ ポイントとして継承されるハイパードライブ実行の一覧。 |
resume_child_runs
必須
|
ハイパードライブの子実行、または新しいハイパードライブ実行の新しい子実行として再開されるハイパードライブの子実行の一覧。 |
pipeline
必須
|
パイプライン実行の構成を設定するパイプライン オブジェクト。
パイプライン オブジェクトは、パイプラインの実行を送信するためにサンプルのハイパーパラメーターを使用して呼び出されます。
|
custom_run_id
必須
|
ユーザーが提供するカスタム実行 ID |
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 です。
戻り値
型 | 説明 |
---|---|
推定器。 |
pipeline
HyperDrive の実行で使用されるパイプラインを返します。
実行でスクリプト実行構成または推定器が使用される場合、値は None です。
戻り値
型 | 説明 |
---|---|
パイプライン。 |
run_config
HyperDrive の実行で使用されるスクリプトまたはノートブックの構成を返します。
実行で推定器またはパイプラインが使用される場合、値は None です。
戻り値
型 | 説明 |
---|---|
実行構成。 |