core パッケージ
Azure Machine Learning のコア パッケージ、モジュール、クラスが含まれています。
主な領域は、コンピューティング 先の管理、ワークスペースと実験の作成/管理、モデル実行の送信/アクセス、出力/ログ記録の実行です。
パッケージ
compute |
このパッケージには、Azure Machine Learning でコンピューティング先を管理するために使用されるクラスが含まれています。 トレーニングとデプロイのコンピューティング 先の選択の詳細については、「Azure Machine Learning のコンピューティング ターゲットとは」を参照してください。 |
image |
Azure Machine Learning で Web サービス エンドポイントとしてデプロイされるイメージを管理するための機能が含まれています。 このクラスは非推奨です。 代わりに Environment クラスを使用してください。 イメージは、web サービス エンドポイントまたは IoT Edge デバイスとして、 Model、スクリプト、および関連付けられているファイルをデプロイするために使用されます。 エンドポイントは、受信スコアリング要求を処理し、予測を返します。 このパッケージの主要なクラスは、 Image クラス、Azure Machine Learning イメージの親クラス、Docker イメージの派生 ContainerImage クラス、および FPGA などのプレビュー イメージです。 画像の使用が特に必要なワークフローがない限り、代わりに Environment クラスを使用してイメージを定義する必要があります。 その後、 Model Model クラスの使用の詳細については、「 Azure Machine Learning を使用してモデルをデプロイする」を参照してください。 カスタム イメージの使用については、「カスタム Docker 基本イメージを使用したモデルのデプロイ」を参照してください。 |
webservice |
Azure Machine Learning で機械学習モデルを Web サービス エンドポイントとしてデプロイするための機能が含まれています。 Azure Machine Learning モデルを Web サービスとしてデプロイすると、エンドポイントと REST API が作成されます。 この API にデータを送信し、モデルによって返された予測を受け取ることができます。 ModelまたはImageを Azure Container Instances (aci モジュール)、Azure Kubernetes Service (aks モジュール)、Azure Kubernetes Endpoint (AksEndpoint)、またはフィールド プログラマブル ゲート アレイ (FPGA) にデプロイするときに、Web サービスを作成します。 ほとんどのユース ケースではモデルを使用したデプロイをお勧めしますが、高度なユース ケースではイメージを使用したデプロイをお勧めします。 このモジュールのクラスでは、どちらの種類のデプロイもサポートされています。 |
モジュール
authentication |
Azure Machine Learning でさまざまな種類の認証を管理するための機能が含まれています。 サポートされている認証の種類:
これらの認証メカニズムの詳細については、 https://aka.ms/aml-notebook-authを参照してください。 |
compute_target |
Azure Machine Learning で管理されていないコンピューティング 先の機能が含まれています。 コンピューティング ターゲットは、トレーニング コンピューティング環境を定義し、クラウド内のローカル リソースまたはリモート リソースを指定できます。 リモート リソースを使用すると、高速 CPU および GPU 処理機能を利用して、機械学習の実験を簡単にスケールアップまたはスケールアウトできます。 Azure Machine Learning によって管理されるコンピューティング ターゲットの詳細については、 ComputeTarget クラスを参照してください。 詳細については、「Azure Machine Learning のコンピューティング先とは」を参照してください。 |
conda_dependencies |
conda 環境の依存関係を管理するための機能が含まれています。 CondaDependencies クラスを使用して、既存の conda 環境ファイルを読み込み、実験を実行する新しい環境を構成および管理します。 |
container_registry |
Azure Container Registry を管理するための機能が含まれています。 |
databricks |
Azure Machine Learning で Databricks 環境を管理するための機能が含まれています。 Azure Machine Learning で Databricks を使用する方法の詳細については、「Azure Machine Learning の開発環境を構成する」を参照してください。 |
dataset |
Azure Machine Learning データセットとの対話を管理します。 このモジュールでは、生データの使用、データの管理、Azure Machine Learning のデータに対するアクションの実行を行うための機能を提供します。 このモジュールの Dataset クラスを使用して、 data パッケージ内の機能と共にデータセットを作成します。これには、 FileDataset と TabularDatasetサポート クラスが含まれています。 データセットの使用を開始するには、データセットの 追加と登録に関する記事を参照してください。 |
datastore |
Azure Machine Learning でデータストアを管理するための機能が含まれています。 |
environment |
Azure Machine Learning で再現可能な環境を作成および管理するための機能が含まれています。 環境では、管理された環境を最小限の手動構成で再現できるように、ソフトウェアの依存関係を管理する方法が提供されます。ローカル開発環境と分散クラウド開発環境の間を移動する際に、最小限の手動構成が可能です。 環境には、Python パッケージ、環境変数、トレーニングスクリプトとスコアリング スクリプトのソフトウェア設定、および Python、Spark、または Docker での実行時間がカプセル化されています。 Azure Machine Learning でのトレーニングとデプロイに環境を使用する方法の詳細については、「 再利用可能な環境の作成と管理」を参照してください。 |
experiment |
Azure Machine Learning で実験の送信と実験履歴の管理に使用される機能が含まれています。 |
keyvault |
Azure Machine Learning ワークスペースに関連付けられている Key Vault 内のシークレットを管理するための機能が含まれています。 このモジュールには、ワークスペースに関連付けられている Azure Key Vault からシークレットを追加、取得、削除、一覧表示するための便利な方法が含まれています。 |
linked_service |
AML ワークスペースでリンクされたサービスを作成および管理するための機能が含まれています。 |
model |
Azure Machine Learning で機械学習モデルを管理するための機能が含まれています。 Model クラスを使用すると、次の主なタスクを実行できます。
モデルの使用方法の詳細については、「 Azure Machine Learning のしくみ: アーキテクチャと概念」を参照してください。 |
private_endpoint |
Azure Private EndPoints を定義および構成するための機能が含まれています。 |
profile |
Azure Machine Learning のモデルをプロファイリングするための機能が含まれています。 |
resource_configuration |
Azure Machine Learning エンティティのリソース構成を管理するための機能が含まれています。 |
run |
Azure Machine Learning で実験メトリックと成果物を管理するための機能が含まれています。 |
runconfig |
Azure Machine Learning での実験実行の構成を管理するための機能が含まれています。 このモジュールの主要なクラスは RunConfigurationであり、指定したコンピューティング 先でトレーニングの実行を送信するために必要な情報をカプセル化します。 この構成には、既存の Python 環境を使用するか、仕様から構築された Conda 環境を使用するかなど、さまざまな動作定義が含まれています。 モジュール内の他の構成クラスには、RunConfiguration を使用してアクセスします。 |
script_run |
Azure Machine Learning で送信されたトレーニング実行を管理するための機能が含まれています。 |
script_run_config |
Azure Machine Learning でトレーニング実行を送信するための構成を管理する機能が含まれています。 |
util |
ログの詳細レベルを指定するためのクラスが含まれています。 |
workspace |
Azure Machine Learning の最上位リソースであるワークスペースを管理するための機能が含まれています。 このモジュールには、 Workspace クラスとそのメソッドと属性が含まれており、コンピューティング ターゲット、環境、データ ストア、実験、モデルなどの機械学習成果物を管理できます。 ワークスペースは Azure サブスクリプションとリソース グループに関連付けられており、課金の主な手段です。 ワークスペースでは、ワークスペース内に保存されたすべての機械学習データに対して、Azure Resource Manager のロールベースのアクセス制御 (RBAC) とリージョン アフィニティがサポートされます。 |
クラス
ComputeTarget |
Azure Machine Learning によって管理されるすべてのコンピューティング ターゲットの抽象親クラス。 コンピューティング ターゲットは、トレーニング スクリプトを実行するか、サービスのデプロイをホストする、指定されたコンピューティング リソース/環境です。 この場所は、ローカル コンピューターでも、クラウドベースのコンピューティング リソースでもかまいません。 詳細については、「Azure Machine Learning のコンピューティング先とは」を参照してください。 Class ComputeTarget コンストラクター。 指定されたワークスペースに関連付けられている Compute オブジェクトのクラウド表現を取得します。 取得した Compute オブジェクトの特定の型に対応する子クラスのインスタンスを返します。 |
ContainerRegistry |
Azure Container Registry への接続を定義します。 クラス ContainerRegistry コンストラクター。 |
Dataset |
Azure Machine Learning でデータを探索、変換、および管理するためのリソースを表します。 データセットは、 Datastore またはパブリック Web URL の背後にあるデータへの参照です。 このクラスで非推奨となったメソッドについては、改善された API AbstractDataset クラスを確認してください。 次のデータセットの種類がサポートされています。
データセットの使用を開始するには、「 データセットの追加と登録」の記事を参照するか、ノートブックの https://aka.ms/tabulardataset-samplenotebook と https://aka.ms/filedataset-samplenotebookを参照してください。 Dataset オブジェクトを初期化します。 ワークスペースに既に登録されているデータセットを取得するには、get メソッドを使用します。 |
Datastore |
Azure Machine Learning ストレージ アカウントに対するストレージの抽象化を表します。 データストアはワークスペースにアタッチされ、Azure Storage サービスへの接続情報を格納するために使用されるため、名前で参照でき、ストレージ サービスへの接続に使用される接続情報とシークレットを覚える必要はありません。 データストアとして登録できるサポートされている Azure ストレージ サービスの例を次に示します。
このクラスを使用して、データストアの登録、一覧表示、取得、削除などの管理操作を実行します。
各サービスのデータストアは、このクラスの データストアの詳細と、データストアを機械学習で使用する方法については、次の記事を参照してください。 名前でデータストアを取得します。 この呼び出しにより、データストア サービスに要求が行われます。 |
Environment |
機械学習実験用に再現可能な Python 環境を構成します。 環境では、データの準備、トレーニング、Web サービスへのデプロイなど、機械学習の実験で使用される Python パッケージ、環境変数、および Docker 設定を定義します。 環境は、Azure Machine Learning Workspaceで管理およびバージョン管理されます。 既存の環境を更新し、再利用するバージョンを取得できます。 環境は、作成されたワークスペースに限定され、異なるワークスペース間で使用することはできません。 環境の詳細については、「 再利用可能な環境の作成と管理」を参照してください。 クラス環境コンストラクター。 |
Experiment |
Azure Machine Learning で実験を作成して操作するための主要なエントリ ポイントを表します。 実験は、複数のモデルの実行を表す 試用版 のコンテナーです。 実験コンストラクター。 |
Image |
Azure Machine Learning イメージの抽象親クラスを定義します。 このクラスは非推奨です。 代わりに Environment クラスを使用してください。 イメージ コンストラクター。 このクラスは非推奨です。 代わりに Environment クラスを使用してください。 イメージ コンストラクターは、指定されたワークスペースに関連付けられている Image オブジェクトのクラウド表現を取得するために使用されます。 取得した Image オブジェクトの特定の型に対応する子クラスのインスタンスを返します。 |
Keyvault |
Azure Machine Learning ワークスペースに関連付けられている Azure Key Vault に格納されているシークレットを管理します。 各 Azure Machine Learning ワークスペースには、Azure Key Vault が関連付けられています。 Keyvault クラスは、Azure Key Vault の簡略化されたラッパーです。これにより、シークレットの設定、取得、削除、一覧表示など、キー コンテナー内のシークレットを管理できます。 Keyvault クラスを使用して、機密情報をクリア テキストで公開することなく、シークレットをリモート実行に安全に渡します。 詳細については、「 トレーニング実行でのシークレットの使用」を参照してください。 クラス Keyvault コンストラクター。 |
LinkedService |
注 これは試験的なクラスであり、いつでも変更される可能性があります。 詳細については、https://aka.ms/azuremlexperimental を参照してください。 AML ワークスペースと Azure 上の他のサービスとの間のリンクを管理するためのリソースを定義します。 LinkedService オブジェクトを初期化します。 |
Model |
機械学習トレーニングの結果を表します。 モデルは、Azure Machine Learning トレーニング Runまたはその他の Azure 以外のモデル トレーニング プロセスの結果です。 モデルの生成方法に関係なく、名前とバージョンで表されるワークスペースに登録できます。 Model クラスを使用すると、Docker で使用するモデルをパッケージ化し、推論要求に使用できるリアルタイム エンドポイントとしてデプロイできます。 モデルの作成方法、管理方法、使用方法を示すエンド ツー エンドのチュートリアルについては、「 AZURE Machine Learning を使用して MNIST データと scikit-learn を使用して画像分類モデルをトレーニングする」を参照してください。 モデル コンストラクター。 Model コンストラクターは、指定されたワークスペースに関連付けられた Model オブジェクトのクラウド表現を取得するために使用されます。 名前または ID を指定する必要があります。 |
PrivateEndPoint |
Azure ML ワークスペースに関連付けられているプライベート エンドポイント接続を管理するためのプライベート エンドポイントを定義します。 PrivateEndPoint を初期化します。 |
PrivateEndPointConfig |
Azure プライベート EndPoint の構成を定義します。 Azure プライベート エンドポイント は、プライベート リンクを使用して Azure ML ワークスペースにプライベートかつ安全に接続するネットワーク インターフェイスです。 PrivateEndPointConfig を初期化します。 |
Run |
すべての Azure Machine Learning 実験実行の基本クラスを定義します。 実行は、実験の 1 回の試行を表します。 実行は、試用版の非同期実行を監視し、メトリックをログに記録し、試用版の出力を格納し、評価版によって生成された結果とアクセス成果物を分析するために使用されます。 実行オブジェクトは、HyperDrive の実行、パイプラインの実行、AutoML の実行など、Azure Machine Learning のさまざまなシナリオでモデルをトレーニングするスクリプトを送信するときに作成されます。 Run オブジェクトは、submit クラスをstart_loggingまたはExperimentするときにも作成されます。 実験と実行を開始するには、次を参照してください。 Run オブジェクトを初期化します。 |
RunConfiguration |
Azure Machine Learning のさまざまなコンピューティング ターゲットを対象とする実験実行の構成を表します。 RunConfiguration オブジェクトは、実験でトレーニングの実行を送信するために必要な情報をカプセル化します。 通常、RunConfiguration オブジェクトは直接作成せず、submit クラスのExperiment メソッドなど、それを返すメソッドから取得します。 RunConfiguration は、トリガーする実行の種類に依存する他の種類の構成手順でも使用される基本環境構成です。 たとえば、 PythonScriptStepを設定するときに、ステップの RunConfiguration オブジェクトにアクセスし、Conda の依存関係を構成したり、実行の環境プロパティにアクセスしたりできます。 実行構成の例については、「 コンピューティング ターゲットを選択して使用してモデルをトレーニングする」を参照してください。 既定の設定で RunConfiguration を初期化します。 |
ScriptRun |
送信されたトレーニング実行を管理するためのプログラムによるアクセスを提供します。 ScriptRunConfigで送信された実行は、実験の 1 回の試用を表します。 実行を送信すると ScriptRun オブジェクトが返されます。このオブジェクトを使用して、実行の非同期実行の監視、メトリックのログ記録、実行の出力の格納、実行によって生成された結果とアクセス成果物の分析を行うことができます。 実験と ScriptRunConf の使用を開始するには、次を参照してください。 Class ScriptRun コンストラクター。 |
ScriptRunConfig |
Azure Machine Learning でトレーニング実行を送信するための構成情報を表します。 ScriptRunConfig は、スクリプト、コンピューティング ターゲット、環境、および分散ジョブ固有の構成など、Azure ML で実行を送信するために必要な構成情報をパッケージ化します。 スクリプトの実行が構成され、 submitで送信されると、 ScriptRun が返されます。 クラス ScriptRunConfig コンストラクター。 |
SynapseWorkspaceLinkedServiceConfiguration |
注 これは試験的なクラスであり、いつでも変更される可能性があります。 詳細については、https://aka.ms/azuremlexperimental を参照してください。 synapse ワークスペースをリンクするためのリンクされたサービス構成を定義します。 SynapseWorkspaceLinkedServiceConfiguration オブジェクトを初期化します。 |
Webservice |
Azure Machine Learning でモデルを Web サービス エンドポイントとしてデプロイするための基本機能を定義します。 Web サービス コンストラクターは、指定されたワークスペースに関連付けられている Web サービス オブジェクトのクラウド表現を取得するために使用されます。 取得した Web サービス オブジェクトの特定の型に対応する子クラスのインスタンスを返します。 Web サービス クラスを使用すると、 Model または Image オブジェクトから機械学習モデルをデプロイできます。 Web サービスの操作の詳細については、「 Azure Machine Learning を使用してモデルをデプロイする」を参照してください。 Web サービス インスタンスを初期化します。 Web サービス コンストラクターは、指定されたワークスペースに関連付けられている Web サービス オブジェクトのクラウド表現を取得します。 取得した Web サービス オブジェクトの特定の型に対応する子クラスのインスタンスが返されます。 |
Workspace |
トレーニングとデプロイの成果物を管理するための Azure Machine Learning リソースを定義します。 ワークスペースは、Azure Machine Learning の機械学習の基本的なリソースです。 ワークスペースを使用して、機械学習モデルの実験、トレーニング、デプロイを行います。 各ワークスペースは、Azure サブスクリプションとリソース グループに関連付けられ、SKU が関連付けられています。 ワークスペースの詳細については、以下を参照してください。 既存の Azure Machine Learning ワークスペースを読み込むクラス ワークスペース コンストラクター。 |
diagnostic_log |
デバッグ ログを指定したファイルに転送します。 |
関数
attach_legacy_compute_target
このプロジェクトにコンピューティング 先をアタッチします。
attach_legacy_compute_target(experiment, source_directory, compute_target)
パラメーター
名前 | 説明 |
---|---|
experiment
必須
|
|
source_directory
必須
|
|
compute_target
必須
|
アタッチするコンピューティング 先オブジェクト。 |
戻り値
型 | 説明 |
---|---|
アタッチが成功した場合は None、それ以外の場合は例外がスローされます。 |
get_run
実行 ID を使用して、この実験の実行を取得します。
get_run(experiment, run_id, rehydrate=True, clean_up=True)
パラメーター
名前 | 説明 |
---|---|
experiment
必須
|
含まれる実験。 |
run_id
必須
|
実行 ID。 |
rehydrate
|
<xref:boolean>
元の実行オブジェクトが返されるか、基本実行オブジェクトのみを返すかを示します。 True の場合、この関数は元の実行オブジェクト型を返します。 たとえば、AutoML 実行の場合、 AutoMLRun オブジェクトが返され、HyperDrive の実行では HyperDriveRun オブジェクトが返されます。 False の場合、関数は Run オブジェクトを返します。 規定値: True
|
clean_up
|
true の場合は、run_baseから_register_kill_handlerを呼び出します 規定値: True
|
戻り値
型 | 説明 |
---|---|
送信された実行。 |
is_compute_target_prepared
コンピューティング 先が準備されていることを確認します。
run_configで指定されたコンピューティング 先が、指定した実行構成に対して既に準備されているかどうかを確認します。
is_compute_target_prepared(experiment, source_directory, run_config)
パラメーター
名前 | 説明 |
---|---|
experiment
必須
|
|
source_directory
必須
|
|
run_config
必須
|
str または
RunConfiguration
実行構成。 これは、実行構成名、文字列、または azureml.core.runconfig.RunConfiguration オブジェクトです。 |
戻り値
型 | 説明 |
---|---|
True の 場合は、コンピューティング 先が準備されています。 |
prepare_compute_target
コンピューティング 先を準備します。
run_configとcustom_run_configに基づいて、実験の実行に必要なすべてのパッケージをインストールします。
prepare_compute_target(experiment, source_directory, run_config)
パラメーター
名前 | 説明 |
---|---|
experiment
必須
|
|
source_directory
必須
|
|
run_config
必須
|
str または
RunConfiguration
実行構成。 これは、実行構成名、文字列、または azureml.core.runconfig.RunConfiguration オブジェクトです。 |
戻り値
型 | 説明 |
---|---|
実行オブジェクト |
remove_legacy_compute_target
プロジェクトからコンピューティング 先を削除します。
remove_legacy_compute_target(experiment, source_directory, compute_target_name)
パラメーター
名前 | 説明 |
---|---|
experiment
必須
|
|
source_directory
必須
|
|
compute_target_name
必須
|
|
戻り値
型 | 説明 |
---|---|
コンピューティング 先の削除が成功した場合は None、それ以外の場合は例外がスローされます。 |