HyperDriveConfig クラス

HyperDrive の実行を定義する構成。

HyperDrive の構成には、ハイパーパラメーター空間サンプリング、終了ポリシー、プライマリメトリック、構成からの再開、推定、および実験の実行を実行するコンピューティングターゲットに関する情報が含まれます。

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 サンプリングされたハイパーパラメーターを使用して呼び出される推定器。 `estimator`、`run_config`、または`pipeline`のいずれかのパラメーターのみを指定します。規定値: None
hyperparameter_sampling 必須	HyperParameterSampling ハイパーパラメーターサンプリング空間。
policy	EarlyTerminationPolicy 使用する早期終了ポリシー。 [なし] - 既定値の場合、早期終了ポリシーは使用されません。 MedianStoppingPolicy 5 の`delay_evaluation`は、最初に適切な終了ポリシーです。これらは保守的な設定であり、(評価データに基づいて) プライマリメトリックで損失を発生させず、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` の両方を指定した場合は、これら 2 つのしきい値のうちの最初のしきい値に達するとハイパーパラメーター調整実験は終了します。
max_concurrent_runs	int 同時に実行する実行の最大数。 None の場合、すべての実行が並列で起動されます。並列実行の数は、指定された計算ターゲットで使用できるリソースに基づいて制御されます。そのため、コンピューティング先に必要なコンカレンシーに使用できるリソースがあることを確認する必要があります。規定値: None
max_duration_minutes	int HyperDrive の実行の最大期間。この時間を超えると、実行中のすべての実行が取り消されます。 `max_total_runs` と `max_duration_minutes` の両方を指定した場合は、これら 2 つのしきい値のうちの最初のしきい値に達するとハイパーパラメーター調整実験は終了します。規定値: 10080
resume_from	HyperDriveRun または list[HyperDriveRun] ハイパードライブの実行、または新しい実行をウォームスタートするためのデータポイントとして継承されるハイパードライブ実行の一覧。規定値: None
resume_child_runs	Run または list[Run] ハイパードライブの子実行、または新しいハイパードライブ実行の新しい子実行として再開されるハイパードライブの子実行の一覧。規定値: None
run_config	ScriptRunConfig スクリプト/ノートブック実行の構成を設定するためのオブジェクト。 `estimator`、`run_config`、または`pipeline`のいずれかのパラメーターのみを指定します。規定値: None
pipeline	Pipeline パイプライン実行の構成を設定するためのパイプラインオブジェクト。パイプラインの実行を送信するために、サンプルのハイパーパラメーターを使用してパイプラインオブジェクトが呼び出されます。 `estimator`、`run_config`、または`pipeline`のいずれかのパラメーターのみを指定します。規定値: None
custom_run_id	str ユーザーによって提供されるカスタム実行 ID 規定値: 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 使用する早期終了ポリシー。 [なし] - 既定値の場合、早期終了ポリシーは使用されません。 <xref:azureml.train.hyperdrive.MedianTerminationPolicy> 5 の`delay_evaluation`は、最初に適切な終了ポリシーです。これらは保守的な設定であり、(評価データに基づいて) プライマリメトリックで損失を発生させず、25%-35% 節約できます。
estimator 必須	MMLBaseEstimator サンプリングされたハイパーパラメーターを使用して呼び出される推定器。 `estimator`、`run_config`、または`pipeline`のいずれかのパラメーターのみを指定します。
run_config 必須	ScriptRunConfig スクリプト/ノートブック実行の構成を設定するためのオブジェクト。 `estimator`、`run_config`、または`pipeline`のいずれかのパラメーターのみを指定します。
resume_from 必須	HyperDriveRun \| list[HyperDriveRun] ハイパードライブの実行、または新しい実行をウォームスタートするためのデータポイントとして継承されるハイパードライブ実行の一覧。
resume_child_runs 必須	Run \| list[Run] ハイパードライブの子実行、または新しいハイパードライブ実行の新しい子実行として再開されるハイパードライブの子実行の一覧。
pipeline 必須	Pipeline パイプライン実行の構成を設定するためのパイプラインオブジェクト。パイプラインの実行を送信するために、サンプルのハイパーパラメーターを使用してパイプラインオブジェクトが呼び出されます。 `estimator`、`run_config`、または`pipeline`のいずれかのパラメーターのみを指定します。
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 です。

戻り値

型	説明
Estimator, None	推定器。

pipeline

HyperDrive の実行で使用されるパイプラインを返します。

実行でスクリプト実行構成またはエスティメーターを使用する場合、値は None です。

戻り値

型	説明
Pipeline, None	パイプライン。

run_config

HyperDrive の実行で使用されるスクリプト/ノートブック構成を返します。

実行でエスティメーターまたはパイプラインを使用する場合、値は None です。

戻り値

型	説明
ScriptRunConfig, None	実行構成。

source_directory

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

戻り値

型	説明
str	ソースディレクトリ