MLClient クラス

  • リファレンス

Azure ML サービスと対話するためのクライアント クラス。

このクライアントを使用して、ワークスペース、ジョブ、モデルなどの Azure ML リソースを管理します。

継承
builtins.object
MLClient

コンストラクター

MLClient(credential: TokenCredential, subscription_id: str | None = None, resource_group_name: str | None = None, workspace_name: str | None = None, registry_name: str | None = None, **kwargs: Any)

パラメーター

credential
TokenCredential
必須

認証に使用する資格情報。

subscription_id
Optional[str]
既定値: None

Azure サブスクリプション ID。 レジストリ資産の場合のみ省略可能です。 既定値は None です。

resource_group_name
Optional[str]
既定値: None

Azure リソース グループ。 レジストリ資産の場合のみ省略可能です。 既定値は None です。

workspace_name
Optional[str]
既定値: None

クライアントで使用するワークスペース。 ワークスペースに依存しない操作に対してのみ省略可能です。 既定値は None です。

registry_name
Optional[str]
既定値: None

クライアントで使用するレジストリ。 ワークスペースに依存しない操作に対してのみ省略可能です。 既定値は None です。

show_progress
Optional[bool]

実行時間の長い操作の進行状況バーを表示するかどうかを指定します (たとえば、対話型セットアップでこの SDK を使用しない場合、お客様はこれを False に設定することを検討できます)。 既定値は True です。

enable_telemetry
Optional[bool]

テレメトリを有効にするかどうかを指定します。 Jupyter Notebookにない場合は False にオーバーライドされます。 Jupyter Notebookの場合、既定値は True です。

cloud
Optional[str]

使用するクラウド名。 既定値は "AzureCloud" です。

例

ソブリン ドメイン (つまり、AZURE_PUBLIC_CLOUD以外のクラウド) を使用する場合は、kwargs でクラウド名を渡す必要があり、DefaultAzureCredential で機関を使用する必要があります。


   from azure.ai.ml import MLClient
   from azure.identity import AzureAuthorityHosts, DefaultAzureCredential

   kwargs = {"cloud": "AzureChinaCloud"}
   ml_client = MLClient(
       subscription_id=subscription_id,
       resource_group_name=resource_group,
       credential=DefaultAzureCredential(authority=AzureAuthorityHosts.AZURE_CHINA),
       **kwargs,
   )

メソッド

begin_create_or_update

Azure ML リソースを非同期的に作成または更新します。
create_or_update

Azure ML リソースを作成または更新します。
from_config

ファイル構成を使用して、既存の Azure Machine Learning ワークスペースからクライアントを返します。

このメソッドを使用すると、複数の Python ノートブックまたはプロジェクトで同じワークスペースを簡単に再利用できます。 次の形式を使用して、ワークスペースの Azure Resource Manager (ARM) プロパティを JSON 構成ファイルに保存できます。


   {
       "subscription_id": "<subscription-id>",
       "resource_group": "<resource-group>",
       "workspace_name": "<workspace-name>"
   }

次に、このメソッドを使用して、ワークスペース ARM プロパティを再入力せずに、異なる Python ノートブックまたはプロジェクトに同じワークスペースを読み込むことができます。

begin_create_or_update

Azure ML リソースを非同期的に作成または更新します。

begin_create_or_update(entity: R, **kwargs) -> LROPoller[R]

パラメーター

entity
Union[Workspace , Registry, Compute, OnlineDeployment , OnlineEndpoint, BatchDeployment , BatchEndpoint, Schedule]
必須

作成または更新するリソース。

戻り値

作成/更新操作後のリソース。

の戻り値の型 :

LROPoller[Union[Workspace , Registry, Compute, OnlineDeployment , OnlineEndpoint, BatchDeployment , BatchEndpoint, Schedule]]

create_or_update

Azure ML リソースを作成または更新します。

create_or_update(entity: T, **kwargs) -> T

パラメーター

entity
Union[Job , Model, Environment, Component , Datastore]
必須

作成または更新するリソース。

戻り値

作成または更新されたリソース。

の戻り値の型 :

Union[Job, Model , Environment, Component, Datastore]

from_config

ファイル構成を使用して、既存の Azure Machine Learning ワークスペースからクライアントを返します。

このメソッドを使用すると、複数の Python ノートブックまたはプロジェクトで同じワークスペースを簡単に再利用できます。 次の形式を使用して、ワークスペースの Azure Resource Manager (ARM) プロパティを JSON 構成ファイルに保存できます。


   {
       "subscription_id": "<subscription-id>",
       "resource_group": "<resource-group>",
       "workspace_name": "<workspace-name>"
   }

次に、このメソッドを使用して、ワークスペース ARM プロパティを再入力せずに、異なる Python ノートブックまたはプロジェクトに同じワークスペースを読み込むことができます。

from_config(credential: TokenCredential, *, path: PathLike | str | None = None, file_name=None, **kwargs) -> MLClient

パラメーター

credential
TokenCredential
必須

ワークスペースの資格情報オブジェクト。

path
Optional[Union[PathLike, str]]

構成ファイルを検索する構成ファイルまたは開始ディレクトリへのパス。 既定値は None で、現在のディレクトリが使用されることを示します。

file_name
Optional[str]

path がディレクトリ パスである場合に検索する構成ファイル名。 既定値は "config.json" です。

cloud
Optional[str]

使用するクラウド名。 既定値は "AzureCloud" です。

戻り値

既存の Azure ML ワークスペースのクライアント。

の戻り値の型 :

MLClient

例外

ValidationException

"config.json"、またはオーバーライドされた場合にfile_nameがディレクトリに見つからない場合に発生します。 詳細はエラー メッセージに表示されます。

例

ディレクトリ "src" の "config.json" という名前のファイルから MLClient を作成する。


   from azure.ai.ml import MLClient

   client = MLClient.from_config(credential=DefaultAzureCredential(), path="./sdk/ml/azure-ai-ml/samples/src")

現在のディレクトリ内の "team_workspace_configuration.json" という名前のファイルから MLClient を作成します。


   from azure.ai.ml import MLClient

   client = MLClient.from_config(
       credential=DefaultAzureCredential(),
       file_name="./sdk/ml/azure-ai-ml/samples/team_workspace_configuration.json",
   )

属性

batch_deployments

バッチデプロイ関連の操作のコレクション。

戻り値

Batch デプロイ操作。

の戻り値の型 :

BatchDeploymentOperations

batch_endpoints

バッチ エンドポイント関連の操作のコレクション。

戻り値

バッチ エンドポイント操作

の戻り値の型 :

BatchEndpointOperations

components

コンポーネント関連の操作のコレクション。

戻り値

コンポーネント操作。

の戻り値の型 :

ComponentOperations

compute

コンピューティング関連の操作のコレクション。

戻り値

コンピューティング操作

の戻り値の型 :

ComputeOperations

connections

ワークスペース接続に関連する操作のコレクション。

戻り値

ワークスペース接続操作

の戻り値の型 :

WorkspaceConnectionsOperations

data

データ関連の操作のコレクション。

戻り値

データ操作。

の戻り値の型 :

DataOperations

datastores

データストア関連の操作のコレクション。

戻り値

データストア操作。

の戻り値の型 :

DatastoreOperations

environments

環境関連の操作のコレクション。

戻り値

環境操作。

の戻り値の型 :

EnvironmentOperations

feature_sets

詳細については、aka.ms/azuremlexperimental を参照してください。

機能セットに関連する操作のコレクション。

戻り値

FeatureSet 操作

の戻り値の型 :

FeatureSetOperations

feature_store_entities

詳細については、aka.ms/azuremlexperimental を参照してください。

機能ストア エンティティに関連する操作のコレクション。

戻り値

FeatureStoreEntity 操作

の戻り値の型 :

FeatureStoreEntityOperations

feature_stores

詳細については、aka.ms/azuremlexperimental を参照してください。

機能ストアに関連する操作のコレクション。

戻り値

FeatureStore 操作

の戻り値の型 :

FeatureStoreOperations

jobs

ジョブ関連の操作のコレクション。

戻り値

ジョブ操作

の戻り値の型 :

JobOperations

models

モデル関連の操作のコレクション。

戻り値

モデル操作

の戻り値の型 :

ModelOperations

online_deployments

オンライン展開に関連する操作のコレクション。

戻り値

オンライン展開操作

の戻り値の型 :

OnlineDeploymentOperations

online_endpoints

オンライン エンドポイント関連の操作のコレクション。

戻り値

オンライン エンドポイント操作

の戻り値の型 :

OnlineEndpointOperations

registries

詳細については、aka.ms/azuremlexperimental を参照してください。

レジストリ関連の操作のコレクション。

戻り値

レジストリの操作

の戻り値の型 :

RegistryOperations

resource_group_name

MLClient オブジェクトのリソース グループ名を取得します。

戻り値

Azure リソース グループ名。

の戻り値の型 :

str

schedules

スケジュール関連の操作のコレクション。

戻り値

操作をスケジュールします。

の戻り値の型 :

ScheduleOperations

subscription_id

MLClient オブジェクトのサブスクリプション ID を取得します。

戻り値

Azure サブスクリプション ID

の戻り値の型 :

str

workspace_hubs

詳細については、aka.ms/azuremlexperimental を参照してください。

ワークスペース ハブ関連の操作のコレクション。

戻り値

ハブ操作

の戻り値の型 :

<xref:HubOperations>

workspace_name

ワークスペースに依存する操作が実行されるワークスペースの名前。

戻り値

既定のワークスペースの名前。

の戻り値の型 :

Optional[str]

workspace_outbound_rules

ワークスペース送信ルール関連の操作のコレクション。

戻り値

ワークスペースの送信規則の操作

の戻り値の型 :

WorkspaceOutboundRuleOperations

workspaces

ワークスペース関連の操作のコレクション。

戻り値

ワークスペース操作

の戻り値の型 :

WorkspaceOperations

R 

R = ~R

T 

T = ~T