core パッケージ

Azure Machine Learning のコア パッケージ、モジュール、およびクラスが含まれています。

主な分野は、コンピューティング先の管理、ワークスペースと実験の作成と管理、モデルの実行の送信とアクセス、実行の出力とログ記録などです。

パッケージ

compute	このパッケージには、Azure Machine Learning のコンピューティング先を管理するために使用するクラスが含まれています。 トレーニングとデプロイのコンピューティング先の選択の詳細については、「Azure Machine Learning でのコンピューティング先とは」を参照してください。
image	Azure Machine Learning で Web サービス エンドポイントとしてデプロイされたイメージを管理するための機能が含まれています。 このクラスは非推奨です。 代わりに Environment クラスを使用してください。 イメージは、Model、スクリプト、関連付けられているファイルを Web サービス エンドポイントまたは IoT Edge デバイスとしてデプロイするために使用されます。 このエンドポイントによって、入ってくるスコアリング要求が処理され、予測が返されます。 このパッケージの主要なクラスは、Azure Machine Learning イメージの親クラスである Image クラスと、Docker イメージや、FPGA などのプレビュー イメージの派生クラスである ContainerImage クラスです。 イメージの使用を特別に必要とするワークフローがない限り、代わりに Environment クラスを使用してイメージを定義する必要があります。 その後、Environment オブジェクトを Modeldeploy() メソッドと併用して、モデルを Web サービスとしてデプロイできます。 Model package() メソッドを使用して、イメージまたは Dockerfile としてローカルの Docker インストール環境にダウンロードできるイメージを作成することもできます。 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 のさまざまな種類の認証を管理するための機能が含まれています。 サポートされている認証の種類: 対話型のログイン - Azure Machine Learning SDK を使用する場合の既定のモード。 対話型ダイアログを使用します。 Azure CLI - azure-cli パッケージで使用します。 サービス プリンシパル - 自動機械学習ワークフローで使用します。 MSI - Azure 仮想マシンなど、マネージド サービス ID 対応のアセットで使用します。 Azure ML トークン - 送信された実行でのみ Azure ML トークンを取得するために使用されます。 これらの認証メカニズムの詳細については、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 クラスを使用して、FileDataset と TabularDataset のサポート クラスが含まれる data パッケージの機能と共にデータセットを作成します。 データセットの使用を開始するには、データセットの 追加 & 登録に関する記事を参照してください。
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 クラスを使用すると、次の主要タスクを実行できます。 ご自身のモデルをワークスペースに登録する ご自身のモデルをプロファイルしてデプロイ要件を理解する ご自身のモデルを Docker で使用できるようにパッケージ化する ご自身のモデルを Web サービスとして推論エンドポイントにデプロイする モデルの使用方法の詳細については、「Azure Machine Learning のしくみ: アーキテクチャと概念」を参照してください。
private_endpoint	Azure プライベート エンドポイントを定義および構成するための機能が含まれます。
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 でのコンピューティング先 に関する記事をご覧ください。 ComputeTarget クラスコンストラクター。 指定されたワークスペースに関連付けられている Compute オブジェクトのクラウド表現を取得します。 取得した Compute オブジェクトの特定の型に対応する子クラスのインスタンスを返します。
ContainerRegistry	Azure Container Registry への接続を定義します。 ContainerRegistry クラス コンストラクター。
Dataset	Azure Machine Learning でデータを探索、変換、および管理するためのリソースを表します。 データセットは、Datastore 内またはパブリック Web URL の背後にあるデータへの参照です。 このクラスで非推奨のメソッドについては、改善された API の AbstractDataset クラスを確認してください。 次のデータセットの種類がサポートされています。 TabularDataset は、指定されたファイルまたはファイルのリストを解析することで作成されたデータを表形式で表します。 FileDataset は、データストア内またはパブリック URL からの 1 つまたは複数のファイルを参照します。 データセットの使用を開始するには、「データセットの 追加 & 登録する」の記事を参照するか、ノートブック https://aka.ms/tabulardataset-samplenotebook と https://aka.ms/filedataset-samplenotebookを参照してください。 Dataset オブジェクトを初期化します。 ワークスペースに既に登録されているデータセットを取得するには、get メソッドを使用します。
Datastore	Azure Machine Learning ストレージ アカウントに対するストレージの抽象化を表します。 データストアはワークスペースにアタッチされ、Azure Storage サービスへの接続情報を格納するために使用されます。これにより、名前で参照することができ、ストレージ サービスへの接続に使用される接続情報とシークレットを記憶する必要がなくなります。 データストアとして登録できるサポート対象の Azure Storage サービスの例は次のとおりです。 Azure BLOB コンテナー Azure ファイル共有 Azure Data Lake Azure Data Lake Gen2 Azure SQL データベース Azure Database for PostgreSQL Databricks ファイル システム Azure Database for MySQL このクラスを使用して、データストアの登録、一覧表示、取得、削除などの管理操作を実行します。 各サービス用のデータストアは、このクラスの register* メソッドを使用して作成されます。 データストアを使用してデータにアクセスする場合、そのデータにアクセスする権限が必要です。権限は、データストアに登録されている資格情報に依存します。 データストアの詳細および機械学習での使用方法については、次の記事を参照してください。 Azure ストレージ サービスのデータにアクセスする Azure Machine Learning で Estimator を使用してモデルをトレーニングする 機械学習パイプラインを作成して実行する 名前を指定してデータストアを取得します。 この呼び出しにより、データストア サービスに要求が行われます。
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	Note これは試験段階のクラスであり、いつでも変更される可能性があります。 詳細については、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 プライベート エンドポイントの構成を定義します。 Azure プライベート エンドポイントは、Private Link を使用して Azure ML ワークスペースにプライベートかつ安全に接続するネットワーク インターフェイスです。 PrivateEndPointConfig を初期化します。
Run	Azure Machine Learning のすべての実験実行に対する基底クラスを定義します。 "実行" は、実験の 1 回の試験を表します。 実行を使用して、試験の非同期実行を監視し、メトリックをログに記録し、試験の出力を保存します。さらに、結果を分析し、試験によって生成された成果物にアクセスします。 Run オブジェクトは、HyperDrive の実行、パイプライン実行、AutoML の実行など、Azure Machine Learning のさまざまなシナリオでモデルをトレーニングするスクリプトを送信するときに作成されます。 Experiment クラスで submit または start_logging を指定する場合も、Run オブジェクトが作成されます。 実験と実行の使用を開始するには、以下を参照してください トレーニングとデプロイのための環境の作成と管理 実行を管理する方法に関するページ Run オブジェクトを初期化します。
RunConfiguration	Azure Machine Learning 内のさまざまなコンピューティング先をターゲットとする実験実行の構成を表します。 RunConfiguration オブジェクトにより、実験でトレーニング実行を送信するために必要な情報がカプセル化されます。 通常、RunConfiguration オブジェクトは、直接作成するのではなく、Experiment クラスの submit メソッドなど、そのオブジェクトを返すメソッドから取得します。 RunConfiguration は、トリガーする実行の種類に応じて、他の種類の構成ステップでも使用される基本環境構成です。 たとえば、PythonScriptStep を設定するときに、ステップの RunConfiguration オブジェクトにアクセスして、Conda 依存関係を構成したり、実行の環境プロパティにアクセスしたりすることができます。 実行構成の例については、モデルをトレーニングするためのコンピューティング先の選択と使用に関する記事をご覧ください。 既定の設定を使用して RunConfiguration を初期化します。
ScriptRun	送信されたトレーニング実行を管理するためのプログラムによるアクセスを提供します。 ScriptRunConfig を使用して送信された実行は、実験の 1 つの試行を表します。 実行を送信すると、ScriptRun オブジェクトが返されます。これを使用して、実行の非同期実行を監視し、メトリックをログに記録し、実行の出力を保存できます。さらに、結果を分析し、実行によって生成された成果物にアクセスできます。 実験と ScriptRunConf の使用を開始するには、以下を参照してください トレーニングとデプロイのための環境の作成と管理 実行を管理する方法に関するページ クラス ScriptRun コンストラクター。
ScriptRunConfig	Azure Machine Learning でトレーニング実行を送信するための構成情報を表します。 ScriptRunConfig を使用して、スクリプト、コンピューティング先、環境、分散型ジョブ固有の構成など、Azure ML で実行を送信するために必要な構成情報をまとめてパッケージ化します。 スクリプト実行が構成され、submit で送信されると、ScriptRun が返されます。 ScriptRunConfig クラスコンストラクター。
SynapseWorkspaceLinkedServiceConfiguration	Note これは試験段階のクラスであり、いつでも変更される可能性があります。 詳細については、https://aka.ms/azuremlexperimental を参照してください。 Synapse ワークスペースをリンクするリンクされたサービス構成を定義します。 SynapseWorkspaceLinkedServiceConfiguration オブジェクトを初期化します。
Webservice	Azure Machine Learning で Web サービス エンドポイントとしてモデルをデプロイするための基本機能を定義します。 Webservice コンストラクターは、指定されたワークスペースに関連付けられている Webservice オブジェクトのクラウド表現を取得するために使用されます。 取得した Webservice オブジェクトの特定の型に対応する子クラスのインスタンスを返します。 Webservice クラスを使用すると、Model または Image オブジェクトから機械学習モデルをデプロイできます。 Webservice の操作の詳細については、Azure Machine Learning を使用したモデルのデプロイに関するページを参照してください。 Webservice インスタンスを初期化します。 Webservice コンストラクターは、指定されたワークスペースに関連付けられている Webservice オブジェクトのクラウド表現を取得します。 取得した Webservice オブジェクトの特定の型に対応する子クラスのインスタンスが返されます。
Workspace	トレーニングおよびデプロイの成果物を管理するための Azure Machine Learning リソースを定義します。 ワークスペースは、Azure Machine Learning での機械学習のための基本的なリソースです。 ワークスペースを使用して、機械学習モデルを実験、トレーニング、デプロイします。 各ワークスペースは、Azure サブスクリプションとリソース グループに関連付けられており、SKU が関連付けられています。 ワークスペースの詳細については、以下を参照してください。 Azure Machine Learning ワークスペースとは ワークスペースへのアクセスの管理 既存の Azure Machine Learning ワークスペースを読み込むクラス ワークスペース コンストラクター。
diagnostic_log	指定されたファイルにデバッグ ログを出力します。

機能

attach_legacy_compute_target

このプロジェクトにコンピューティング先をアタッチします。

attach_legacy_compute_target(experiment, source_directory, compute_target)

パラメーター

experiment

Experiment

必須

source_directory

str

必須

compute_target

str

必須

アタッチするコンピューティング先オブジェクト。

戻り値

アタッチが成功した場合は None、それ以外の場合は例外をスローします。

get_run

実行 ID を使用して、この実験の実行を取得します。

get_run(experiment, run_id, rehydrate=True, clean_up=True)

パラメーター

experiment

Experiment

必須

実行が含まれている実験。

run_id

string

必須

実行 ID。

rehydrate

<xref:boolean>

既定値: True

元の実行オブジェクトが返されるか、または基本の実行オブジェクトだけが返されるかを示します。 True の場合は、この関数から、元の実行オブジェクトの型が返されます。 たとえば、AutoML の実行では、AutoMLRun オブジェクトが返されますが、HyperDrive の実行では、HyperDriveRun オブジェクトが返されます。

False の場合、関数から、Run オブジェクトが返されます。

clean_up

bool

既定値: True

true の場合は、run_baseから _register_kill_handler を呼び出します

戻り値

送信された実行。

の戻り値の型 :

Run

is_compute_target_prepared

コンピューティング先が準備されていることを検査します。

run_config に指定されたコンピューティング先が、指定された実行構成に対して既に準備されているかどうかを検査します。

is_compute_target_prepared(experiment, source_directory, run_config)

パラメーター

experiment

Experiment

必須

source_directory

str

必須

run_config

str または RunConfiguration

必須

実行構成。 これには、実行構成名 (文字列) または azureml.core.runconfig.RunConfiguration オブジェクトを指定できます。

戻り値

コンピューティング先が準備されている場合は True。

の戻り値の型 :

bool

prepare_compute_target

コンピューティング先を準備します。

run_config と custom_run_config に基づいて、実験実行に必要なすべてのパッケージをインストールします。

prepare_compute_target(experiment, source_directory, run_config)

パラメーター

experiment

Experiment

必須

source_directory

str

必須

run_config

str または RunConfiguration

必須

実行構成。 これには、実行構成名 (文字列) または azureml.core.runconfig.RunConfiguration オブジェクトを指定できます。

戻り値

実行オブジェクト

の戻り値の型 :

ScriptRun

remove_legacy_compute_target

コンピューティング先をプロジェクトから削除します。

remove_legacy_compute_target(experiment, source_directory, compute_target_name)

パラメーター

experiment

Experiment

必須

source_directory

str

必須

compute_target_name

str

必須

戻り値

コンピューティング先の削除が成功した場合は None、それ以外の場合は例外をスローします。

の戻り値の型 :

None