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)

パラメーター

estimator
MMLBaseEstimator
既定値: None

サンプリングされたハイパーパラメーターを使用して呼び出される推定器。 estimatorrun_configpipeline のいずれかのパラメーターのみを指定します。

hyperparameter_sampling
HyperParameterSampling
必須

ハイパーパラメーターのサンプリング空間

policy
EarlyTerminationPolicy
既定値: None

使用する早期終了ポリシー。 None (既定値) の場合、早期終了ポリシーは使用されません。

MedianStoppingPolicydelay_evaluation を 5 に設定するのは、最初に使用する終了ポリシーとして有効です。 これらは保守的な設定であり、(評価データに基づいて) 主要メトリックに関する損失なしで 25% から 35% の節約を実現できます。

primary_metric_name
str
必須

実験の実行によって報告された主要メトリックの名前。

primary_metric_goal
PrimaryMetricGoal
必須

PrimaryMetricGoal.MINIMIZE または PrimaryMetricGoal.MAXIMIZE のいずれかです。 このパラメーターは、実行の評価時にプライマリ メトリックを最小化するか最大化するかを決定します。

max_total_runs
int
必須

作成する実行の最大総数。 これは上限です。サンプル空間がこの値より小さい場合は、実行回数が少なくなる可能性があります。 max_total_runsmax_duration_minutes の両方を指定した場合は、これら 2 つのしきい値のうちの最初のしきい値に達するとハイパーパラメーター調整実験は終了します。

max_concurrent_runs
int
既定値: None

同時に実行できる実行の最大数。 None の場合、すべての実行が並列で起動されます。 並列実行の数は、指定された計算ターゲットで使用できるリソースに基づいて制御されます。 そのため、目的の同時実行可能性のために、計算ターゲットに必要なリソースを確保する必要があります。

max_duration_minutes
int
既定値: 10080

HyperDrive の実行の最大継続時間。 この時間を超えると、実行中の実行は取り消されます。 max_total_runsmax_duration_minutes の両方を指定した場合は、これら 2 つのしきい値のうちの最初のしきい値に達するとハイパーパラメーター調整実験は終了します。

resume_from
HyperDriveRun または list[HyperDriveRun]
既定値: None

ハイパードライブ実行、または新しい実行をウォーム スタートするためのデータ ポイントとして継承されるハイパードライブ実行の一覧。

resume_child_runs
Run または list[Run]
既定値: None

ハイパードライブの子実行、または新しいハイパードライブ実行の新しい子実行として再開されるハイパードライブの子実行の一覧。

run_config
ScriptRunConfig
既定値: None

スクリプト/ノートブック実行の構成を設定するオブジェクト。 estimatorrun_configpipeline のいずれかのパラメーターのみを指定します。

pipeline
Pipeline
既定値: None

パイプライン実行の構成を設定するパイプライン オブジェクト。 パイプライン オブジェクトは、パイプラインの実行を送信するためにサンプルのハイパーパラメーターを使用して呼び出されます。 estimatorrun_configpipeline の次のいずれかのパラメーターのみを指定します。

custom_run_id
str
既定値: None

ユーザーが提供するカスタム実行 ID

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
必須

サンプリングされたハイパー パラメーターを使用して呼び出される推定器。 estimatorrun_configpipeline の次のいずれかのパラメーターのみを指定します。

run_config
ScriptRunConfig
必須

スクリプト/ノートブック実行の構成を設定するオブジェクト。 estimatorrun_configpipeline の次のいずれかのパラメーターのみを指定します。

resume_from
HyperDriveRun | list[HyperDriveRun]
必須

ハイパードライブの実行、または新しい実行をウォーム スタートするためのデータ ポイントとして継承されるハイパードライブ実行の一覧。

resume_child_runs
Run | list[Run]
必須

ハイパードライブの子実行、または新しいハイパードライブ実行の新しい子実行として再開されるハイパードライブの子実行の一覧。

pipeline
Pipeline
必須

パイプライン実行の構成を設定するパイプライン オブジェクト。 パイプライン オブジェクトは、パイプラインの実行を送信するためにサンプルのハイパーパラメーターを使用して呼び出されます。 estimatorrun_configpipeline の次のいずれかのパラメーターのみを指定します。

custom_run_id
str
必須

ユーザーが提供するカスタム実行 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 です。

戻り値

実行構成。

の戻り値の型 :

source_directory

実行する構成からソース ディレクトリを返します。

戻り値

ソース ディレクトリ

の戻り値の型 :

str