ComputeInstance クラス

リファレンス

Azure Machine Learning でクラウドベースの最適化された ML 開発環境を管理します。

Azure Machine Learning コンピューティングインスタンスは、機械学習開発ワークフロー用に最適化された、クラウド内の完全に構成されたマネージド開発環境です。 ComputeInstance は、通常、開発環境を作成するために使用されたり、開発とテストのトレーニングと推論のコンピューティング先として使用されたりします。 ComputeInstance を使用すると、ワークスペース内の完全に統合されたノートブックエクスペリエンスでモデルを作成、トレーニング、およびデプロイできます。詳細については、「Azure Machine Learning コンピューティングインスタンスとは」を参照してください。

ComputeTarget クラスのコンストラクター。

指定されたワークスペースに関連付けられている Compute オブジェクトのクラウド表現を取得します。取得した Compute オブジェクトの特定の型に対応する子クラスのインスタンスを返します。

継承: ComputeTarget

ComputeInstance

コンストラクター

ComputeInstance(workspace, name)

パラメーター

名前	説明
workspace 必須	Workspace 取得する Compute オブジェクトを含むワークスペースオブジェクト。
name 必須	str 取得する Compute オブジェクトのの名前。

メソッド

delete	その関連ワークスペースから ComputeInstance オブジェクトを削除します。
deserialize	JSON オブジェクトを ComputeInstance オブジェクトに変換します。指定されたワークスペースが、ComputeInstance が関連付けられたワークスペースでない場合は、失敗します。
detach	デタッチは ComputeInstance オブジェクトに対してサポートされていません。代わりに delete を使用してください
get	ComputeInstance オブジェクトを返します。
get_active_runs	このコンピューティングの実行ジェネレーターを返します。
get_docs_url	このクラスのドキュメントへの URL。
get_status	ComputeInstance の現在の詳細な状態を取得します。
provisioning_configuration	ComputeInstance ターゲットをプロビジョニングするための構成オブジェクトを作成します。
refresh_state	オブジェクトのプロパティのインプレース更新を実行します。このメソッドは、対応するクラウドオブジェクトの現在の状態に基づいてプロパティを更新します。これは、主に、コンピューティング状態の手動ポーリングに役立ちます。
restart	ComputeInstance を再起動します。
serialize	この ComputeInstance オブジェクトを JSON でシリアル化された辞書に変換します。
start	ComputeInstance を開始します。
stop	ComputeInstance を停止します。
supported_vmsizes	リージョンでサポートされている VM のサイズを一覧表示します。
wait_for_completion	ComputeInstance がプロビジョニングを完了するまで待機します。

delete

その関連ワークスペースから ComputeInstance オブジェクトを削除します。

delete(wait_for_completion=False, show_output=False)

パラメーター

名前	説明
wait_for_completion	規定値: False
show_output	規定値: False

例外

型	説明
ComputeTargetException

注釈

このオブジェクトが Azure ML によって作成された場合は、対応するクラウドベースのオブジェクトも削除されます。このオブジェクトが外部で作成され、ワークスペースにのみアタッチされている場合は、例外が発生し、何も変更されません。

deserialize

JSON オブジェクトを ComputeInstance オブジェクトに変換します。

指定されたワークスペースが、ComputeInstance が関連付けられたワークスペースでない場合は、失敗します。

static deserialize(workspace, object_dict)

パラメーター

名前	説明
workspace 必須	Workspace ComputeInstance オブジェクトが関連付けられたワークスペースオブジェクト。
object_dict 必須	dict ComputeInstance オブジェクトに変換する JSON オブジェクト。

戻り値

型	説明
ComputeInstance	指定された JSON オブジェクトの ComputeInstance 表現。

例外

型	説明
ComputeTargetException

detach

デタッチは ComputeInstance オブジェクトに対してサポートされていません。代わりに delete を使用してください

detach()

例外

型	説明
ComputeTargetException	この操作はサポートされていません。

get

ComputeInstance オブジェクトを返します。

get()

戻り値

型	説明
ComputeInstance	指定された JSON オブジェクトの ComputeInstance 表現。

例外

型	説明
ComputeTargetException

get_active_runs

このコンピューティングの実行ジェネレーターを返します。

get_active_runs(type=None, tags=None, properties=None, status=None)

パラメーター

名前	説明
type	str 返された実行ジェネレーターを、指定された種類でフィルター処理します。実行の種類の作成については、add_type_provider を参照してください。規定値: None
tags	str または dict "tag" または {"tag": "value"} で実行をフィルター処理規定値: None
properties	str または dict "property" または {"property": "value"} で実行をフィルター処理規定値: None
status	str 実行の状態、"実行中" または "キューに登録済み" にすることができます。規定値: None

戻り値

型	説明
<xref:builtin.generator>	azureml._restclient.models.RunDto のジェネレーター

例外

型	説明
ComputeTargetException

get_docs_url

このクラスのドキュメントへの URL。

get_docs_url()

戻り値

型	説明
str	url

例外

型	説明
ComputeTargetException

get_status

ComputeInstance の現在の詳細な状態を取得します。

get_status()

戻り値

型	説明
ComputeInstanceStatus	コンピューティングの詳細な状態オブジェクト

例外

型	説明
ComputeTargetException

provisioning_configuration

ComputeInstance ターゲットをプロビジョニングするための構成オブジェクトを作成します。

static provisioning_configuration(vm_size='', ssh_public_access=False, admin_user_ssh_public_key=None, vnet_resourcegroup_name=None, vnet_name=None, subnet_name=None, tags=None, description=None, assigned_user_object_id=None, assigned_user_tenant_id=None)

パラメーター

名前	説明
vm_size 必須	str エージェント VM のサイズ。詳細については、https://aka.ms/azureml-vm-details を参照してください。前のリンクで詳しく説明されているように、すべてのリージョンですべてのサイズが利用できるわけではないことに注意してください。既定値は Standard_NC6 です。
ssh_public_access	bool パブリック SSH ポートの状態を示します。次のいずれかの値になります。 False - パブリック SSH ポートは閉じられています。 True - パブリック SSH ポートは開いています。規定値: False
admin_user_ssh_public_key	str 管理者ユーザーアカウントの SSH 公開キー。規定値: None
vnet_resourcegroup_name	str 仮想ネットワークが配置されているリソースグループの名前。規定値: None
vnet_name	str 仮想ネットワークの名前。規定値: None
subnet_name	str VNet 内のサブネットの名前。規定値: None
tags	dict[str, str] Compute オブジェクトに関連付けるキー値タグの辞書 (オプション)。規定値: None
description	str Compute オブジェクトに関する説明 (オプション)。規定値: None
assigned_user_object_id	str ロール割り当て済みユーザーの AAD オブジェクト ID (プレビュー)。規定値: None
assigned_user_tenant_id	str ロール割り当て済みユーザーの AAD テナント ID (プレビュー)。規定値: None

戻り値

型	説明
ComputeInstanceProvisioningConfiguration	Compute オブジェクトの作成時に使用される構成オブジェクト。

例外

型	説明
ComputeTargetException

refresh_state

オブジェクトのプロパティのインプレース更新を実行します。

このメソッドは、対応するクラウドオブジェクトの現在の状態に基づいてプロパティを更新します。これは、主に、コンピューティング状態の手動ポーリングに役立ちます。

refresh_state()

例外

型	説明
ComputeTargetException

restart

ComputeInstance を再起動します。

restart(wait_for_completion=False, show_output=False)

パラメーター

名前	説明
wait_for_completion	bool 状態の更新を待機するブール値。既定値は False です。規定値: False
show_output	bool より詳細な出力を提供するブール値。既定値は False です。規定値: False

戻り値

型	説明
None	None

例外

型	説明
azureml.exceptions.ComputeTargetException:

serialize

この ComputeInstance オブジェクトを JSON でシリアル化された辞書に変換します。

serialize()

戻り値

型	説明
dict	この ComputeInstance オブジェクトの JSON 表現。

例外

型	説明
ComputeTargetException

start

ComputeInstance を開始します。

start(wait_for_completion=False, show_output=False)

パラメーター

名前	説明
wait_for_completion	bool 状態の更新を待機するかどうか。既定値は False です。規定値: False
show_output	bool より詳細な出力を提供するかどうか。既定値は False です。規定値: False

戻り値

型	説明
None	None

例外

型	説明
ComputeTargetException

stop

ComputeInstance を停止します。

stop(wait_for_completion=False, show_output=False)

パラメーター

名前	説明
wait_for_completion	bool 状態の更新を待機するかどうか。既定値は False です。規定値: False
show_output	bool より詳細な出力を提供するかどうか。既定値は False です。規定値: False

戻り値

型	説明
None	None

例外

型	説明
ComputeTargetException

supported_vmsizes

リージョンでサポートされている VM のサイズを一覧表示します。

static supported_vmsizes(workspace, location=None)

パラメーター

名前	説明
workspace 必須	Workspace ワークスペース。
location	str インスタンスの場所。指定されなかった場合、既定値はワークスペースの場所です。規定値: None

戻り値

型	説明
list	リージョン内でサポートされている VM のサイズと、VM の名前、VCPU、および RAM のリスト。

例外

型	説明
ComputeTargetException

wait_for_completion

ComputeInstance がプロビジョニングを完了するまで待機します。

wait_for_completion(show_output=False, is_delete_operation=False)

パラメーター

名前	説明
show_output	bool より詳細な出力を提供するかどうか。既定値は False です。規定値: False
is_delete_operation	bool 操作が削除を目的としたものであるかどうかを示します。規定値: False

例外

型	説明
ComputeTargetException

次の方法で共有

ComputeInstance クラス

コンストラクター

パラメーター

メソッド

delete

パラメーター

例外

注釈

deserialize

パラメーター

戻り値

例外

detach

例外

get

戻り値

例外

get_active_runs

パラメーター

戻り値

例外

get_docs_url

戻り値

例外

get_status

戻り値

例外

provisioning_configuration

パラメーター

戻り値

例外

refresh_state

例外

restart

パラメーター

戻り値

例外

serialize

戻り値

例外

start

パラメーター

戻り値

例外

stop

パラメーター

戻り値

例外

supported_vmsizes

パラメーター

戻り値

例外

wait_for_completion

パラメーター

例外

フィードバック

その他のリソース