ComputeInstance クラス
Azure Machine Learning でクラウドベースの最適化された ML 開発環境を管理します。
Azure Machine Learning コンピューティング インスタンスは、機械学習開発ワークフロー用に最適化された、クラウド内で完全に構成されたマネージド開発環境です。 ComputeInstance は、通常、開発環境を作成するために、または開発とテストのためのトレーニングと推論のコンピューティング ターゲットとして使用されます。 ComputeInstance を使用すると、ワークスペース内の完全に統合されたノートブック エクスペリエンスでモデルを作成、トレーニング、デプロイできます。 詳細については、「Azure Machine Learning コンピューティング インスタンスとは」を参照してください。
Class ComputeTarget コンストラクター。
指定されたワークスペースに関連付けられている Compute オブジェクトのクラウド表現を取得します。 取得した Compute オブジェクトの特定の型に対応する子クラスのインスタンスを返します。
コンストラクター
ComputeInstance(workspace, name)
パラメーター
名前 | 説明 |
---|---|
workspace
必須
|
取得する Compute オブジェクトを含むワークスペース オブジェクト。 |
name
必須
|
取得する 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 サイズを一覧表示します。 |
update_sso_settings |
コンピューティング インスタンスのシングル サインオン設定を更新します。 |
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
必須
|
ComputeInstance オブジェクトが関連付けられているワークスペース オブジェクト。 |
object_dict
必須
|
ComputeInstance オブジェクトに変換する JSON オブジェクト。 |
戻り値
型 | 説明 |
---|---|
指定された JSON オブジェクトの ComputeInstance 表現。 |
例外
型 | 説明 |
---|---|
detach
get
ComputeInstance オブジェクトを返します。
get()
戻り値
型 | 説明 |
---|---|
指定された JSON オブジェクトの ComputeInstance 表現。 |
例外
型 | 説明 |
---|---|
get_active_runs
このコンピューティングの実行のジェネレーターを返します。
get_active_runs(type=None, tags=None, properties=None, status=None)
パラメーター
名前 | 説明 |
---|---|
type
|
指定された型で実行の返されたジェネレーターをフィルター処理します。 実行の種類の作成については、 add_type_provider を参照してください。 規定値: None
|
tags
|
"tag" または {"tag": "value"} で実行をフィルター処理する 規定値: None
|
properties
|
"property" または {"property": "value"} で実行をフィルター処理する 規定値: None
|
status
|
実行状態は、"実行中" または "Queued" にすることができます。 規定値: None
|
戻り値
型 | 説明 |
---|---|
<xref:builtin.generator>
|
azureml._restclient.models.RunDto のジェネレーター |
get_docs_url
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
必須
|
エージェント VM のサイズ。 詳細については、以下を参照してください: https://aka.ms/azureml-vm-details. 前のリンクで詳しく説明したように、すべてのリージョンですべてのサイズを使用できるわけではないことに注意してください。 既定値は Standard_NC6 です。 |
ssh_public_access
|
パブリック SSH ポートの状態を示します。 使用可能な値は次のとおりです。
規定値: False
|
admin_user_ssh_public_key
|
管理者ユーザー アカウントの SSH 公開キー。 規定値: None
|
vnet_resourcegroup_name
|
仮想ネットワークが配置されているリソース グループの名前。 規定値: None
|
vnet_name
|
仮想ネットワークの名前。 規定値: None
|
subnet_name
|
vnet 内のサブネットの名前。 規定値: None
|
tags
|
コンピューティング オブジェクトに関連付けるキー値タグの省略可能なディクショナリ。 規定値: None
|
description
|
コンピューティング オブジェクトの説明 (省略可能)。 規定値: None
|
assigned_user_object_id
|
割り当てられたユーザーの AAD オブジェクト ID (プレビュー)。 規定値: None
|
assigned_user_tenant_id
|
割り当てられたユーザーの AAD テナント ID (プレビュー)。 規定値: None
|
戻り値
型 | 説明 |
---|---|
Compute オブジェクトの作成時に使用する構成オブジェクト。 |
例外
型 | 説明 |
---|---|
refresh_state
オブジェクトのプロパティのインプレース更新を実行します。
このメソッドは、対応するクラウド オブジェクトの現在の状態に基づいてプロパティを更新します。 これは主に、コンピューティング状態の手動ポーリングに役立ちます。
refresh_state()
restart
serialize
この ComputeInstance オブジェクトを JSON シリアル化ディクショナリに変換します。
serialize()
戻り値
型 | 説明 |
---|---|
この ComputeInstance オブジェクトの JSON 表記。 |
start
ComputeInstance を開始します。
start(wait_for_completion=False, show_output=False)
パラメーター
名前 | 説明 |
---|---|
wait_for_completion
|
状態の更新を待機するかどうか。 既定値は False です。 規定値: False
|
show_output
|
より詳細な出力を提供するかどうか。 既定値は False です。 規定値: False
|
戻り値
型 | 説明 |
---|---|
なし |
例外
型 | 説明 |
---|---|
stop
ComputeInstance を停止します。
stop(wait_for_completion=False, show_output=False)
パラメーター
名前 | 説明 |
---|---|
wait_for_completion
|
状態の更新を待機するかどうか。 既定値は False です。 規定値: False
|
show_output
|
より詳細な出力を提供するかどうか。 既定値は False です。 規定値: False
|
戻り値
型 | 説明 |
---|---|
なし |
例外
型 | 説明 |
---|---|
supported_vmsizes
update_sso_settings
wait_for_completion
ComputeInstance がプロビジョニングを完了するまで待ちます。
wait_for_completion(show_output=False, is_delete_operation=False)
パラメーター
名前 | 説明 |
---|---|
show_output
|
より詳細な出力を提供するかどうか。 既定値は False です。 規定値: False
|
is_delete_operation
|
操作が削除対象かどうかを示します。 規定値: False
|
例外
型 | 説明 |
---|---|