Share via


ComputeInstance クラス

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

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

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

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

継承
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

例外

注釈

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

deserialize

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

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

static deserialize(workspace, object_dict)

パラメーター

workspace
Workspace
必須

ComputeInstance オブジェクトが関連付けられたワークスペース オブジェクト。

object_dict
dict
必須

ComputeInstance オブジェクトに変換する JSON オブジェクト。

戻り値

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

の戻り値の型 :

例外

detach

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

detach()

例外

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

get

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

get()

戻り値

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

の戻り値の型 :

例外

get_active_runs

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

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

パラメーター

type
str
既定値: None

返された実行ジェネレーターを、指定された種類でフィルター処理します。 実行の種類の作成については、add_type_provider を参照してください。

tags
str または dict
既定値: None

"tag" または {"tag": "value"} で実行をフィルター処理

properties
str または dict
既定値: None

"property" または {"property": "value"} で実行をフィルター処理

status
str
既定値: None

実行の状態、"実行中" または "キューに登録済み" にすることができます。

戻り値

azureml._restclient.models.RunDto のジェネレーター

の戻り値の型 :

<xref:builtin.generator>

例外

get_docs_url

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

get_docs_url()

戻り値

url

の戻り値の型 :

str

例外

get_status

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

get_status()

戻り値

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

の戻り値の型 :

例外

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
既定値: False

パブリック SSH ポートの状態を示します。 次のいずれかの値になります。

  • False - パブリック SSH ポートは閉じられています。
  • True - パブリック SSH ポートは開いています。
admin_user_ssh_public_key
str
既定値: None

管理者ユーザー アカウントの SSH 公開キー。

vnet_resourcegroup_name
str
既定値: None

仮想ネットワークが配置されているリソース グループの名前。

vnet_name
str
既定値: None

仮想ネットワークの名前。

subnet_name
str
既定値: None

VNet 内のサブネットの名前。

tags
dict[str, str]
既定値: None

Compute オブジェクトに関連付けるキー値タグの辞書 (オプション)。

description
str
既定値: None

Compute オブジェクトに関する説明 (オプション)。

assigned_user_object_id
str
既定値: None

ロール割り当て済みユーザーの AAD オブジェクト ID (プレビュー)。

assigned_user_tenant_id
str
既定値: None

ロール割り当て済みユーザーの AAD テナント ID (プレビュー)。

戻り値

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

の戻り値の型 :

例外

refresh_state

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

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

refresh_state()

例外

restart

ComputeInstance を再起動します。

restart(wait_for_completion=False, show_output=False)

パラメーター

wait_for_completion
bool
既定値: False

状態の更新を待機するブール値。 既定値は False です。

show_output
bool
既定値: False

より詳細な出力を提供するブール値。 既定値は False です。

戻り値

None

の戻り値の型 :

例外

azureml.exceptions.ComputeTargetException:

serialize

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

serialize()

戻り値

この ComputeInstance オブジェクトの JSON 表現。

の戻り値の型 :

例外

start

ComputeInstance を開始します。

start(wait_for_completion=False, show_output=False)

パラメーター

wait_for_completion
bool
既定値: False

状態の更新を待機するかどうか。 既定値は False です。

show_output
bool
既定値: False

より詳細な出力を提供するかどうか。 既定値は False です。

戻り値

None

の戻り値の型 :

例外

stop

ComputeInstance を停止します。

stop(wait_for_completion=False, show_output=False)

パラメーター

wait_for_completion
bool
既定値: False

状態の更新を待機するかどうか。 既定値は False です。

show_output
bool
既定値: False

より詳細な出力を提供するかどうか。 既定値は False です。

戻り値

None

の戻り値の型 :

例外

supported_vmsizes

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

static supported_vmsizes(workspace, location=None)

パラメーター

workspace
Workspace
必須

ワークスペース。

location
str
既定値: None

インスタンスの場所。 指定されなかった場合、既定値はワークスペースの場所です。

戻り値

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

の戻り値の型 :

例外

wait_for_completion

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

wait_for_completion(show_output=False, is_delete_operation=False)

パラメーター

show_output
bool
既定値: False

より詳細な出力を提供するかどうか。 既定値は False です。

is_delete_operation
bool
既定値: False

操作が削除を目的としたものであるかどうかを示します。

例外