Estimator クラス
提供されたフレームワークを使用してデータをトレーニングするための汎用推定器を表します。
非推奨。 独自に定義した環境または Azure ML キュレーション環境でScriptRunConfigオブジェクトを使用します。 ScriptRunConfig で実験の実行を構成する方法の概要については、「トレーニングの実行を構成して送信する」を参照してください。
このクラスは、Azure Machine Learning の事前に構成された推定器がない機械学習フレームワークで使用するように設計されています。 事前に構成された推定器は、Chainer、PyTorch、TensorFlow、SKLearn 用が存在します。 事前に構成されていない推定器を作成するには、Azure Machine Learning で推定器を使用したモデルのトレーニングに関する記事をご覧ください。
Estimator クラスは、実行構成情報をラップして、スクリプトの実行方法を指定するタスクをシンプルにするのに役立ちます。 単一ノード実行とマルチノード実行がサポートされています。 推定器を実行すると、トレーニング スクリプトで指定された出力ディレクトリ内にモデルが生成されます。
推定器を初期化します。
azureml.core.environment._DEFAULT_SHM_SIZEが使用されます。 詳細については、Docker 実行リファレンスを参照してください。 :type shm_size: str :p aram resume_from: 実験を再開するチェックポイント またはモデル ファイルを含むデータ パス。 :type resume_from: azureml.data.datapath.DataPath :p aram max_run_duration_seconds: 実行に許容される最大時間。 Azure ML では、自動的に
この値よりも時間がかかる場合は、実行を取り消します。
- 継承
-
azureml.train.estimator._mml_base_estimator.MMLBaseEstimatorEstimator
コンストラクター
Estimator(source_directory, *, compute_target=None, vm_size=None, vm_priority=None, entry_script=None, script_params=None, node_count=1, process_count_per_node=1, distributed_backend=None, distributed_training=None, use_gpu=False, use_docker=True, custom_docker_base_image=None, custom_docker_image=None, image_registry_details=None, user_managed=False, conda_packages=None, pip_packages=None, conda_dependencies_file_path=None, pip_requirements_file_path=None, conda_dependencies_file=None, pip_requirements_file=None, environment_variables=None, environment_definition=None, inputs=None, source_directory_data_store=None, shm_size=None, resume_from=None, max_run_duration_seconds=None, _disable_validation=True, _show_lint_warnings=False, _show_package_warnings=False)
パラメーター
名前 | 説明 |
---|---|
source_directory
必須
|
トレーニング ジョブに必要な実験構成とコード ファイルが含まれるローカル ディレクトリ。 |
compute_target
必須
|
トレーニングが発生するコンピューティング先。 これは、オブジェクトまたは文字列 "local" のいずれかです。 |
vm_size
必須
|
トレーニング用に作成されるコンピューティング先の VM サイズ。 サポートされる値: 任意の Azure VM サイズ。 |
vm_priority
必須
|
トレーニング用に作成されるコンピューティング先の VM 優先度。 指定しない場合は、'dedicated' が使用されます。 サポートされる値: 'dedicated' と 'lowpriority'。 これは、 |
entry_script
必須
|
トレーニングの開始に使用するファイルへの相対パス。 |
script_params
必須
|
|
node_count
必須
|
トレーニングに使用するコンピューティング先のノードの数。 1 より大きい場合は、MPI 分散ジョブが実行されます。 |
process_count_per_node
必須
|
各ノード上で実行するプロセス ("worker") の数。 1 より大きい場合は、MPI 分散ジョブが実行されます。 分散ジョブには、AmlCompute ターゲットのみがサポートされています。 |
distributed_backend
必須
|
分散トレーニング用の通信バックエンド。 非推奨。
サポートされる値: 'mpi'。 'mpi' は MPI/Horovod を表します。 このパラメーターは、
|
distributed_training
必須
|
分散トレーニング ジョブを実行するためのパラメーター。 MPI バックエンドで分散ジョブを実行する場合は、Mpi オブジェクトを使用して |
use_gpu
必須
|
実験を実行する環境で GPU をサポートする必要があるかどうかを指定します。
true の場合は、GPU ベースの既定の Docker イメージが環境内で使用されます。 false の場合、CPU ベースのイメージが使用されます。 既定の Docker イメージ (CPU または GPU) は、 |
use_docker
必須
|
実験を実行するための環境を Docker ベースにするかどうかを指定します。 |
custom_docker_base_image
必須
|
Docker イメージの名前。トレーニングに使用するイメージは、この Docker イメージからビルドされます。 非推奨。
設定しない場合は、既定の CPU ベースのイメージが基本イメージとして使用されます。 |
custom_docker_image
必須
|
Docker イメージの名前。トレーニングに使用するイメージは、この Docker イメージからビルドされます。 設定されていない場合、既定の CPU ベースのイメージが基本イメージとして使用されます。 パブリックな Docker リポジトリ (Docker Hub) 内の使用可能なイメージのみを指定します。 プライベートな docker リポジトリにあるイメージを使用するには、コンストラクターの |
image_registry_details
必須
|
Docker イメージ レジストリの詳細。 |
user_managed
必須
|
Azure ML が既存の Python 環境を再利用するかどうかを指定します。 false の場合、conda の依存関係の仕様に基づいて、Python 環境が作成されます。 |
conda_packages
必須
|
実験用の Python 環境に追加される conda パッケージを表す文字列のリスト。 |
pip_packages
必須
|
実験用の Python 環境に追加される pip パッケージを表す文字列のリスト。 |
conda_dependencies_file_path
必須
|
conda の依存関係 yaml ファイルへの相対パス。 指定した場合、Azure ML によって、フレームワーク関連のパッケージはインストールされません。 非推奨。
|
pip_requirements_file_path
必須
|
pip 要件テキスト ファイルへの相対パス。 非推奨。
このパラメーターは、 |
conda_dependencies_file
必須
|
conda の依存関係 yaml ファイルへの相対パス。 指定した場合、Azure ML によって、フレームワーク関連のパッケージはインストールされません。 |
pip_requirements_file
必須
|
pip 要件テキスト ファイルへの相対パス。
このパラメーターは、 |
environment_variables
必須
|
環境変数の名前と値のディクショナリ。 これらの環境変数は、ユーザー スクリプトが実行されるプロセスで設定されます。 |
environment_definition
必須
|
実験の環境定義。 PythonSection、DockerSection、および環境変数が含まれます。 他のパラメーターを介して推定器構造に直接公開されていない環境オプションは、このパラメーターを使用して設定できます。 このパラメーターを指定すると、 |
inputs
必須
|
入力として使用する DataReference または DatasetConsumptionConfig オブジェクトのリスト。 |
source_directory_data_store
必須
|
プロジェクト共有のバッキング データ ストア。 |
shm_size
必須
|
Docker コンテナーの共有メモリ ブロックのサイズ。 設定しなかった場合は、既定の azureml.core.environment._DEFAULT_SHM_SIZE が使用されます。 詳細については、Docker 実行リファレンスを参照してください。 |
resume_from
必須
|
実験を再開するためのチェックポイント ファイルまたはモデル ファイルが含まれているデータ パス。 |
max_run_duration_seconds
必須
|
実行の最大許容時間。 この値よりも時間がかかる場合、Azure ML によって自動的に実行のキャンセルが試みられます。 |
source_directory
必須
|
トレーニング ジョブに必要な実験構成とコード ファイルが含まれるローカル ディレクトリ。 |
compute_target
必須
|
トレーニングが発生するコンピューティング先。 これは、オブジェクトまたは文字列 "local" のいずれかです。 |
vm_size
必須
|
トレーニング用に作成されるコンピューティング先の VM サイズ。 サポートされる値: 任意の Azure VM サイズ。 |
vm_priority
必須
|
トレーニング用に作成されるコンピューティング先の VM 優先度。 指定しない場合は、'dedicated' が使用されます。 サポートされる値: 'dedicated' と 'lowpriority'。 これは、 |
entry_script
必須
|
トレーニングの開始に使用するファイルへの相対パス。 |
script_params
必須
|
|
node_count
必須
|
トレーニングに使用するコンピューティング先のノードの数。 1 より大きい場合は、MPI 分散ジョブが実行されます。 分散ジョブには、AmlCompute ターゲットのみがサポートされています。 |
process_count_per_node
必須
|
ノードあたりのプロセスの数。 1 より大きい場合は、MPI 分散ジョブが実行されます。 分散ジョブには、AmlCompute ターゲットのみがサポートされています。 |
distributed_backend
必須
|
分散トレーニング用の通信バックエンド。 非推奨。
サポートされる値: 'mpi'。 'mpi' は MPI/Horovod を表します。 このパラメーターは、
|
distributed_training
必須
|
分散トレーニング ジョブを実行するためのパラメーター。 MPI バックエンドで分散ジョブを実行する場合は、Mpi オブジェクトを使用して |
use_gpu
必須
|
実験を実行する環境で GPU をサポートする必要があるかどうかを指定します。
true の場合、GPU ベースの既定の Docker イメージが環境で使用されます。 false の場合、CPU ベースのイメージが使用されます。 既定の Docker イメージ (CPU または GPU) は、 |
use_docker
必須
|
実験を実行するための環境を Docker ベースにするかどうかを指定します。 |
custom_docker_base_image
必須
|
Docker イメージの名前。トレーニングに使用するイメージは、この Docker イメージからビルドされます。 非推奨。
設定しない場合は、既定の CPU ベースのイメージが基本イメージとして使用されます。 |
custom_docker_image
必須
|
Docker イメージの名前。トレーニングに使用するイメージは、この Docker イメージからビルドされます。 設定されていない場合、既定の CPU ベースのイメージが基本イメージとして使用されます。 パブリックな Docker リポジトリ (Docker Hub) 内の使用可能なイメージのみを指定します。 プライベートな docker リポジトリにあるイメージを使用するには、コンストラクターの |
image_registry_details
必須
|
Docker イメージ レジストリの詳細。 |
user_managed
必須
|
Azure ML が既存の Python 環境を再利用するかどうかを指定します。 false の場合、conda の依存関係の仕様に基づいて、Python 環境が作成されます。 |
conda_packages
必須
|
実験用の Python 環境に追加される conda パッケージを表す文字列のリスト。 |
pip_packages
必須
|
実験用の Python 環境に追加される pip パッケージを表す文字列のリスト。 |
conda_dependencies_file_path
必須
|
conda の依存関係 yaml ファイルへの相対パス。 指定した場合、Azure ML によって、フレームワーク関連のパッケージはインストールされません。 非推奨。
|
pip_requirements_file_path
必須
|
pip 要件テキスト ファイルへの相対パス。 非推奨。
これは、 |
pip_requirements_file
必須
|
pip 要件テキスト ファイルへの相対パス。
これは、 |
environment_variables
必須
|
環境変数の名前と値のディクショナリ。 これらの環境変数は、ユーザー スクリプトが実行されるプロセスで設定されます。 |
environment_definition
必須
|
実験の環境定義。 PythonSection、DockerSection、および環境変数が含まれます。 他のパラメーターを介して推定器構造に直接公開されていない環境オプションは、このパラメーターを使用して設定できます。 このパラメーターを指定すると、 |
inputs
必須
|
入力として使用する DataReference または DatasetConsumptionConfig オブジェクトのリスト。 |
source_directory_data_store
必須
|
プロジェクト共有のバッキング データ ストア。 |
shm_size
必須
|
Docker コンテナーの共有メモリ ブロックのサイズ。 設定されていない場合は、既定の |
_disable_validation
必須
|
実行の送信前にスクリプトの検証を無効にします。 既定値は True です。 |
_show_lint_warnings
必須
|
スクリプトリンティングの警告を表示します。 既定値は False です。 |
_show_package_warnings
必須
|
パッケージ検証の警告を表示します。 既定値は False です。 |