Estimator クラス
提供されたフレームワークを使用してデータをトレーニングする汎用推定器を表します。
廃止。 独自に定義された環境または Azure ML でキュレーションされた環境で ScriptRunConfig オブジェクトを使用します。 ScriptRunConfig を使用した実験実行の構成の概要については、「 トレーニング実行の構成と送信」を参照してください。
このクラスは、Azure Machine Learning の事前構成済み推定機能がまだない機械学習フレームワークで使用するように設計されています。 Chainer、PyTorch、TensorFlow、およびSKLearn用に事前構成された推定器が存在します。 事前構成されていない Estimator を作成するには、「Estimator を 使用して 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 は自動的に試みます
この値よりも時間がかかる場合は、実行を取り消します。
コンストラクター
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 イメージの名前。 廃止。
設定しない場合は、既定の CPU ベースのイメージが基本イメージとして使用されます。 |
custom_docker_image
必須
|
トレーニングに使用するイメージのビルド元となる 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、環境変数が含まれます。 他のパラメーターを介して Estimator 構築に直接公開されない環境オプションは、このパラメーターを使用して設定できます。 このパラメーターを指定すると、 |
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 イメージの名前。 廃止。
設定しない場合は、既定の CPU ベースのイメージが基本イメージとして使用されます。 |
custom_docker_image
必須
|
トレーニングに使用するイメージのビルド元となる 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、環境変数が含まれます。 他のパラメーターを介して Estimator 構築に直接公開されない環境オプションは、このパラメーターを使用して設定できます。 このパラメーターを指定すると、 |
inputs
必須
|
入力として使用する DataReference または DatasetConsumptionConfig オブジェクトの一覧。 |
source_directory_data_store
必須
|
プロジェクト共有のバッキング データ ストア。 |
shm_size
必須
|
Docker コンテナーの共有メモリ ブロックのサイズ。 設定されていない場合は、既定の |
_disable_validation
必須
|
送信を実行する前にスクリプトの検証を無効にします。 既定値は True です。 |
_show_lint_warnings
必須
|
スクリプトリンティングの警告を表示します。 既定値は False です。 |
_show_package_warnings
必須
|
パッケージ検証の警告を表示します。 既定値は False です。 |