SKLearn クラス

Scikit-learn 実験でトレーニングするための推定器を作成します。

廃止。 独自に定義された環境または AzureML-Tutorial キュレーションされた環境で ScriptRunConfig オブジェクトを使用します。 ScriptRunConfig を使用した SKLearn 実験実行の構成の概要については、「 Azure Machine Learning を使用して scikit-learn モデルを大規模にトレーニングする」を参照してください。

この推定器は、単一ノードの CPU トレーニングのみをサポートします。

サポートされているバージョン: 0.20.3

Scikit-learn 推定器を初期化します。

コンストラクター

SKLearn(source_directory, *, compute_target=None, vm_size=None, vm_priority=None, entry_script=None, script_params=None, use_docker=True, 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, shm_size=None, resume_from=None, max_run_duration_seconds=None, framework_version=None, _enable_optimized_mode=False, _disable_validation=True, _show_lint_warnings=False, _show_package_warnings=False)

パラメーター

名前	説明
source_directory 必須	str 実験構成ファイルを含むローカル ディレクトリ。
compute_target 必須	AbstractComputeTarget または str トレーニングが行われるコンピューティング 先。 オブジェクトまたは文字列 "local" を指定できます。
vm_size 必須	str トレーニング用に作成されるコンピューティング 先の VM サイズ。 サポートされている値: 任意の Azure VM サイズ。
vm_priority 必須	str トレーニング用に作成されるコンピューティング 先の VM の優先順位。 指定しない場合は、'dedicated' が使用されます。 サポートされている値: 'dedicated' と 'lowpriority'。 これは、入力に vm_size param が指定されている場合にのみ有効になります。
entry_script 必須	str トレーニングを開始するために使用されるファイルへの相対パスを表す文字列。
script_params 必須	dict entry_scriptで指定されたトレーニング スクリプトに渡すコマンド ライン引数のディクショナリ。
custom_docker_image 必須	str トレーニングに使用するイメージのビルド元となる Docker イメージの名前。 設定しない場合は、既定の CPU ベースのイメージが基本イメージとして使用されます。
image_registry_details 必須	ContainerRegistry Docker イメージ レジストリの詳細。
user_managed 必須	bool Azure ML が既存の Python 環境を再利用するかどうかを指定します。 False は、AzureML が conda 依存関係の仕様に基づいて Python 環境を作成することを意味します。
conda_packages 必須	list 実験用に Python 環境に追加する conda パッケージを表す文字列の一覧。
pip_packages 必須	list 実験用に Python 環境に追加される pip パッケージを表す文字列の一覧。
conda_dependencies_file_path 必須	str conda 依存関係 yaml ファイルへの相対パスを表す文字列。 指定した場合、Azure ML はフレームワーク関連のパッケージをインストールしません。 これは、 conda_packages パラメーターと組み合わせて指定できます。 廃止。 conda_dependencies_file パラメーターを使用します。
pip_requirements_file_path 必須	str pip 要件テキスト ファイルへの相対パスを表す文字列。 これは、 pip_packages パラメーターと組み合わせて指定できます。 廃止。 pip_requirements_file パラメーターを使用します。
conda_dependencies_file 必須	str conda 依存関係 yaml ファイルへの相対パスを表す文字列。 指定した場合、Azure ML はフレームワーク関連のパッケージをインストールしません。 これは、 conda_packages パラメーターと組み合わせて指定できます。
pip_requirements_file 必須	str pip 要件テキスト ファイルへの相対パスを表す文字列。 これは、 pip_packages パラメーターと組み合わせて指定できます。
environment_variables 必須	dict 環境変数の名前と値のディクショナリ。 これらの環境変数は、ユーザー スクリプトが実行されているプロセスで設定されます。
environment_definition 必須	Environment 実験の環境定義には、PythonSection、DockerSection、環境変数が含まれます。 他のパラメーターを介して Estimator 構築に直接公開されない環境オプションは、 environment_definition パラメーターを使用して設定できます。 このパラメーターを指定すると、 use_gpu、 custom_docker_image、 conda_packages、 pip_packagesなどの他の環境関連パラメーターよりも優先されます。 エラーは無効な組み合わせで報告されます。
inputs 必須	list 入力として使用する DataReference または DatasetConsumptionConfig オブジェクトの一覧。
shm_size 必須	str Docker コンテナーの共有メモリ ブロックのサイズ。 設定しない場合は、既定のazureml.core.environment._DEFAULT_SHM_SIZEが使用されます。
resume_from 必須	DataPath 実験を再開するチェックポイントまたはモデル ファイルを含むデータ パス。
max_run_duration_seconds 必須	int 実行の最大許容時間。 この値よりも時間がかかる場合、Azure ML は実行を自動的に取り消そうとします。
framework_version 必須	str トレーニング コードの実行に使用される Scikit-learn バージョン。 SKLearn.get_supported_versions() は、現在の SDK でサポートされているバージョンの一覧を返します。
source_directory 必須	str 実験構成ファイルを含むローカル ディレクトリ。
compute_target 必須	AbstractComputeTarget または str トレーニングが行われるコンピューティング 先。 オブジェクトまたは文字列 "local" を指定できます。
vm_size 必須	str トレーニング用に作成されるコンピューティング 先の VM サイズ。 サポートされている値: 任意の Azure VM サイズ。
vm_priority 必須	str トレーニング用に作成されるコンピューティング 先の VM の優先順位。 指定しない場合は、'dedicated' が使用されます。 サポートされている値: 'dedicated' と 'lowpriority'。 これは、入力に vm_size param が指定されている場合にのみ有効になります。
entry_script 必須	str トレーニングを開始するために使用されるファイルへの相対パスを表す文字列。
script_params 必須	dict entry_scriptで指定されたトレーニング スクリプトに渡すコマンド ライン引数のディクショナリ。
use_docker 必須	bool 実験を実行する環境が Docker ベースであるかどうかを示すブール値。
custom_docker_image 必須	str トレーニングに使用するイメージのビルド元となる Docker イメージの名前。 設定しない場合は、既定の CPU ベースのイメージが基本イメージとして使用されます。
image_registry_details 必須	ContainerRegistry Docker イメージ レジストリの詳細。
user_managed 必須	bool Azure ML が既存の Python 環境を再利用するかどうかを指定します。 False は、AzureML が conda 依存関係の仕様に基づいて Python 環境を作成することを意味します。
conda_packages 必須	list 実験用に Python 環境に追加する conda パッケージを表す文字列の一覧。
pip_packages 必須	list 実験用に Python 環境に追加される pip パッケージを表す文字列の一覧。
conda_dependencies_file_path 必須	str conda 依存関係 yaml ファイルへの相対パスを表す文字列。 指定した場合、Azure ML はフレームワーク関連のパッケージをインストールしません。 これは、 conda_packages パラメーターと組み合わせて指定できます。 廃止。 conda_dependencies_file パラメーターを使用します。
pip_requirements_file_path 必須	str pip 要件テキスト ファイルへの相対パスを表す文字列。 これは、 pip_packages パラメーターと組み合わせて指定できます。 廃止。 pip_requirements_file パラメーターを使用します。
conda_dependencies_file 必須	str conda 依存関係 yaml ファイルへの相対パスを表す文字列。 指定した場合、Azure ML はフレームワーク関連のパッケージをインストールしません。 これは、 conda_packages パラメーターと組み合わせて指定できます。
pip_requirements_file 必須	str pip 要件テキスト ファイルへの相対パスを表す文字列。 これは、 pip_packages パラメーターと組み合わせて指定できます。
environment_variables 必須	dict 環境変数の名前と値のディクショナリ。 これらの環境変数は、ユーザー スクリプトが実行されているプロセスで設定されます。
environment_definition 必須	Environment 実験の環境定義には、PythonSection、DockerSection、環境変数が含まれます。 他のパラメーターを介して Estimator 構築に直接公開されない環境オプションは、 environment_definition パラメーターを使用して設定できます。 このパラメーターを指定すると、 use_gpu、 custom_docker_image、 conda_packages、 pip_packagesなどの他の環境関連パラメーターよりも優先されます。 エラーは無効な組み合わせで報告されます。
inputs 必須	list azureml.data.data_referenceの一覧。入力として使用する DataReference オブジェクト。
shm_size 必須	str Docker コンテナーの共有メモリ ブロックのサイズ。 設定しない場合は、既定のazureml.core.environment._DEFAULT_SHM_SIZEが使用されます。
resume_from 必須	DataPath 実験を再開するチェックポイントまたはモデル ファイルを含むデータ パス。
max_run_duration_seconds 必須	int 実行の最大許容時間。 この値よりも時間がかかる場合、Azure ML は実行を自動的に取り消そうとします。
framework_version 必須	str トレーニング コードの実行に使用される Scikit-learn バージョン。 SKLearn.get_supported_versions() は、現在の SDK でサポートされているバージョンの一覧を返します。
_enable_optimized_mode 必須	bool 事前構築済みのフレームワーク イメージを使用して増分環境ビルドを有効にして、環境の準備を高速化します。 事前構築済みのフレームワーク イメージは、フレームワークの依存関係が事前にインストールされている Azure ML の既定の CPU/GPU ベース イメージの上に構築されます。
_disable_validation 必須	bool 送信を実行する前にスクリプトの検証を無効にします。 既定値は True です。
_show_lint_warnings 必須	bool スクリプトリンティングの警告を表示します。 既定値は False です。
_show_package_warnings 必須	bool パッケージ検証の警告を表示します。 既定値は False です。

注釈

トレーニング ジョブを送信すると、Azure ML は Docker コンテナー内の conda 環境でスクリプトを実行します。 SKLearn コンテナーには、次の依存関係がインストールされています。

依存関係 |Scikit-learn 0.20.3 |———————- |—————– |Python |3.6.2 |azureml-defaults |最新 |IntelMpi |2018.3.222 |scikit-learn |0.20.3 |numpy |1.16.2 |miniconda |4.5.11 |scipy |1.2.1 |joblib |0.13.2 |git |2.7.4 |

Docker イメージは Ubuntu 16.04 を拡張します。

追加の依存関係をインストールする必要がある場合は、 pip_packages または conda_packages パラメーターを使用するか、 pip_requirements_file または conda_dependencies_file ファイルを指定できます。 または、独自のイメージをビルドし、 custom_docker_image パラメーターを推定コンストラクターに渡すこともできます。

属性

DEFAULT_VERSION

DEFAULT_VERSION = '0.20.3'

FRAMEWORK_NAME

FRAMEWORK_NAME = 'SKLearn'