SKLearn クラス

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

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

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

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

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

継承
azureml.train.estimator._framework_base_estimator._FrameworkBaseEstimator
SKLearn

コンストラクター

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

トレーニングが発生するコンピューティング先。 これは、オブジェクトまたは文字列 "local" のいずれかです。

vm_size
必須
str

トレーニング用に作成されるコンピューティング先の VM サイズ。

サポートされる値: 任意の Azure VM サイズ

vm_priority
必須
str

トレーニング用に作成されるコンピューティング先の VM 優先度。 指定しない場合は、'dedicated' が使用されます。

サポートされる値: 'dedicated' と 'lowpriority'。

これは、入力で vm_size param を指定した場合にのみ有効になります。

entry_script
必須
str

トレーニングを開始するために使うファイルへの相対パスを表す文字列。

script_params
必須

entry_script 内で指定したトレーニング スクリプトに渡すコマンド ライン引数のディクショナリ。

custom_docker_image
必須
str

Docker イメージの名前。トレーニングに使用するイメージは、この Docker イメージからビルドされます。 設定しない場合は、既定の CPU ベースのイメージが基本イメージとして使用されます。

image_registry_details
必須

Docker イメージ レジストリの詳細。

user_managed
必須

Azure ML が既存の Python 環境を再利用するかどうかを指定します。 false は、conda の依存関係の仕様に基づいて、Azure ML によって Python 環境が作成されることを意味します。

conda_packages
必須

実験用の Python 環境に追加される conda パッケージを表す文字列のリスト。

pip_packages
必須

実験用の 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
必須

環境変数の名前と値のディクショナリ。 これらの環境変数は、ユーザー スクリプトが実行されるプロセスで設定されます。

environment_definition
必須

実験用の環境定義には、PythonSection、DockerSection、環境変数が含まれています。 他のパラメーターを介して推定器構造に直接公開されていない環境オプションは、environment_definition パラメーターを使用して設定できます。 このパラメーターを指定すると、use_gpucustom_docker_imageconda_packagespip_packages などの他の環境関連パラメーターよりも優先されます。 無効な組み合わせに対してエラーが報告されます。

inputs
必須

入力として使用する DataReference または DatasetConsumptionConfig オブジェクトのリスト。

shm_size
必須
str

Docker コンテナーの共有メモリ ブロックのサイズ。 設定しなかった場合は、既定の azureml.core.environment._DEFAULT_SHM_SIZE が使用されます。

resume_from
必須

実験を再開するためのチェックポイント ファイルまたはモデル ファイルが含まれているデータ パス。

max_run_duration_seconds
必須
int

実行の最大許容時間。 この値よりも時間がかかる場合は、Azure ML によって自動的に実行のキャンセルが試みられます。

framework_version
必須
str

トレーニング コードの実行に使用される Scikit-learn バージョン。 SKLearn.get_supported_versions() は、現在の SDK でサポートされているバージョンのリストを返します。

source_directory
必須
str

実験構成ファイルが含まれるローカル ディレクトリ。

compute_target
必須

トレーニングが発生するコンピューティング先。 これは、オブジェクトまたは文字列 "local" のいずれかです。

vm_size
必須
str

トレーニング用に作成されるコンピューティング先の VM サイズ。 サポートされる値: 任意の Azure VM サイズ

vm_priority
必須
str

トレーニング用に作成されるコンピューティング先の VM 優先度。 指定しない場合は、'dedicated' が使用されます。

サポートされる値: 'dedicated' と 'lowpriority'。

これは、入力で vm_size param を指定した場合にのみ有効になります。

entry_script
必須
str

トレーニングを開始するために使うファイルへの相対パスを表す文字列。

script_params
必須

entry_script 内で指定したトレーニング スクリプトに渡すコマンド ライン引数のディクショナリ。

use_docker
必須

実験を実行する環境が Docker ベースであるかどうかを示すブール値。

custom_docker_image
必須
str

Docker イメージの名前。トレーニングに使用するイメージは、この Docker イメージからビルドされます。 設定しない場合は、既定の CPU ベースのイメージが基本イメージとして使用されます。

image_registry_details
必須

Docker イメージ レジストリの詳細。

user_managed
必須

Azure ML が既存の Python 環境を再利用するかどうかを指定します。 false は、conda の依存関係の仕様に基づいて、Azure ML によって Python 環境が作成されることを意味します。

conda_packages
必須

実験用の Python 環境に追加される conda パッケージを表す文字列のリスト。

pip_packages
必須

実験用の 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
必須

環境変数の名前と値のディクショナリ。 これらの環境変数は、ユーザー スクリプトが実行されるプロセスで設定されます。

environment_definition
必須

実験用の環境定義には、PythonSection、DockerSection、環境変数が含まれています。 他のパラメーターを介して推定器構造に直接公開されていない環境オプションは、environment_definition パラメーターを使用して設定できます。 このパラメーターを指定すると、use_gpucustom_docker_imageconda_packagespip_packages などの他の環境関連パラメーターよりも優先されます。 無効な組み合わせに対してエラーが報告されます。

inputs
必須

azureml.data.data_referenceの一覧。入力として使用する DataReference オブジェクト。

shm_size
必須
str

Docker コンテナーの共有メモリ ブロックのサイズ。 設定しなかった場合は、既定の azureml.core.environment._DEFAULT_SHM_SIZE が使用されます。

resume_from
必須

実験を再開するためのチェックポイント ファイルまたはモデル ファイルが含まれているデータ パス。

max_run_duration_seconds
必須
int

実行の最大許容時間。 この値よりも時間がかかる場合は、Azure ML によって自動的に実行のキャンセルが試みられます。

framework_version
必須
str

トレーニング コードの実行に使用される Scikit-learn バージョン。 SKLearn.get_supported_versions() は、現在の SDK でサポートされているバージョンのリストを返します。

_enable_optimized_mode
必須

事前構築済みのフレームワーク イメージを使用して増分環境ビルドを有効にして、環境の準備を高速化します。 事前構築済みのフレームワーク イメージは、フレームワークの依存関係が事前にインストールされている Azure ML の既定の CPU/GPU ベース イメージの上に構築されています。

_disable_validation
必須

実行の送信前にスクリプトの検証を無効にします。 既定値は True です。

_show_lint_warnings
必須

スクリプトリンティングの警告を表示します。 既定値は False です。

_show_package_warnings
必須

パッケージ検証の警告を表示します。 既定値は False です。

注釈

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

Dependencies | Scikit-learn 0.20.3 | ———————- | —————– | Python | 3.6.2 | azureml-defaults | Latest | 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'