Image クラス

Azure Machine Learning イメージの抽象親クラスを定義します。

このクラスは非推奨です。 代わりに Environment クラスを使用してください。

イメージ コンストラクター。

このクラスは非推奨です。 代わりに Environment クラスを使用してください。

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

継承
Image

コンストラクター

Image(workspace, name=None, id=None, tags=None, properties=None, version=None)

パラメーター

workspace
Workspace
必須

取得するイメージを含む Workspace オブジェクト。

name
str
既定値: None

取得するイメージの名前。 イメージの最新バージョンが存在する場合、それを返します。

id
str
既定値: None

取得するイメージの特定の ID。 (ID は "<name>:<version>" です)

tags
list
既定値: None

指定されたリストに基づいて、'key' または '[key, value]' でイメージの結果をフィルター処理します。 例: ['key', ['key2', 'key2 value']]

properties
list
既定値: None

指定されたリストに基づいて、'key' または '[key, value]' でイメージの結果をフィルター処理します。 例: ['key', ['key2', 'key2 value']]

version
str
既定値: None

バージョンと名前が両方とも指定されている場合、特定バージョンのイメージを返します。

workspace
Workspace
必須

取得する Image を含むワークスペース オブジェクト

name
str
必須

取得するイメージの名前。 最新バージョンが返されます (存在する場合)

id
str
必須

取得するイメージの特定の ID。 (ID は ":")

tags
list
必須

指定されたリストに基づいて、'key' または '[key, value]' でイメージの結果をフィルター処理します。 例: ['key', ['key2', 'key2 value']]

properties
list
必須

指定されたリストに基づいて、'key' または '[key, value]' でイメージの結果をフィルター処理します。 例: ['key', ['key2', 'key2 value']]

version
str
必須

バージョンと名前が両方とも指定されている場合、特定バージョンのイメージを返します。

注釈

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

Image オブジェクトは、ユーザーの ModelWebservice としてデプロイするために使用されます。 Image オブジェクトには、モデル、実行スクリプト、モデル デプロイに必要な依存関係が通常は含まれます。 Image クラスには、Docker イメージ用の ContainerImage などの複数のサブクラスや、FPGA のような複数のイメージがあります。

Image クラスから継承するクラスの例については、「ContainerImage クラス」を参照してください。

Image は、イメージを使用する必要があるワークフロー内で通常は使用されます。 ほとんどのワークフローでは、代わりに Environment クラスを使用してイメージを定義する必要があります。 その後、Environment オブジェクトを Modeldeploy() メソッドと併用して、モデルを Web サービスとしてデプロイできます。 Model package() メソッドを使用して、イメージまたは Dockerfile としてローカルの Docker インストール環境にダウンロードできるイメージを作成することもできます。

Azure でモデルをデプロイする方法の概要については、次のリンクを参照してください: https://aka.ms/azureml-how-deploy

メソッド

add_properties

イメージにプロパティを追加します。

add_tags

イメージにタグを追加します。

create

指定されたワークスペース内にイメージを作成します。

delete

対応するワークスペースからイメージを削除します。

deserialize

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

image_configuration

イメージ構成オブジェクトを作成するための抽象メソッド。

list

対応するワークスペースに関連付けられているイメージをリストします。 特定のパラメーターを使用してフィルター処理できます。

remove_tags

イメージからタグを削除します。

serialize

この Image オブジェクトを JSON のシリアル化されたディクショナリに変換します。

update

イメージを更新します。

update_creation_state

メモリ内オブジェクトの現在の状態を更新します。

対応するクラウド オブジェクトの現在の状態に基づいて、オブジェクトのプロパティのインプレース更新を実行します。 作成状態を手動でポーリングする場合に特に便利です。

wait_for_creation

イメージの作成が完了するまで待機します。

イメージの作成が最終状態になるまで待機します。 到達した最終状態が失敗の場合、WebserviceException をスローします。

add_properties

イメージにプロパティを追加します。

add_properties(properties)

パラメーター

properties
dict[str, str]
必須

追加するプロパティのディクショナリ。

例外

add_tags

イメージにタグを追加します。

add_tags(tags)

パラメーター

tags
dict[str, str]
必須

追加するタグのディクショナリ。

例外

create

指定されたワークスペース内にイメージを作成します。

static create(workspace, name, models, image_config)

パラメーター

workspace
<xref:<xref:workspace: azureml.core.workspace.Workspace>>
必須

このイメージに関連付けるワークスペース。

name
str
必須

このイメージに関連付ける名前。

models
list[Model]
必須

このイメージを使用してパッケージ化する Model オブジェクトのリスト。 空のリストにすることができます。

image_config
ImageConfig
必須

このイメージの構成に使用するイメージ構成オブジェクト。

戻り値

作成された Image オブジェクト。

の戻り値の型 :

例外

delete

対応するワークスペースからイメージを削除します。

delete()

例外

注釈

イメージが稼働中の Web サービスにデプロイされている場合、このメソッドは失敗します。

deserialize

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

deserialize(workspace, image_payload)

パラメーター

cls
必須

クラス メソッドを示します。

workspace
Workspace
必須

イメージが登録されている Workspace オブジェクト。

image_payload
dict
必須

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

戻り値

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

の戻り値の型 :

例外

注釈

イメージが登録されていないワークスペースを指定した場合、このメソッドは失敗します。

image_configuration

イメージ構成オブジェクトを作成するための抽象メソッド。

abstract static image_configuration()

例外

list

対応するワークスペースに関連付けられているイメージをリストします。 特定のパラメーターを使用してフィルター処理できます。

static list(workspace, image_name=None, model_name=None, model_id=None, tags=None, properties=None)

パラメーター

workspace
Workspace
必須

イメージをリストする Workspace オブジェクト。

image_name
str
既定値: None

特定のイメージ名を持つデプロイ済みイメージのみを含めるようにリストをフィルター処理します。

model_name
str
既定値: None

特定のモデル名を持つデプロイ済みイメージのみを含めるようにリストをフィルター処理します。

model_id
str
既定値: None

特定のモデル ID を持つデプロイ済みイメージのみを含めるようにリストをフィルター処理します。

tags
list
既定値: None

指定されたリストに基づいて、'key' または '[key, value]' でフィルター処理します。 例: ['key', ['key2', 'key2 value']]

properties
list
既定値: None

指定されたリストに基づいて、'key' または '[key, value]' でフィルター処理します。 例: ['key', ['key2', 'key2 value']]

戻り値

指定されたワークスペース内のフィルター処理されたイメージのリスト。

の戻り値の型 :

list[<xref:Images>]

例外

remove_tags

イメージからタグを削除します。

remove_tags(tags)

パラメーター

tags
list[str]
必須

削除するタグに対応するキーのリスト。

例外

serialize

この Image オブジェクトを JSON のシリアル化されたディクショナリに変換します。

serialize()

戻り値

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

の戻り値の型 :

例外

update

イメージを更新します。

update(tags)

パラメーター

tags
dict[str, str]
必須

イメージの更新時に使用するタグのディクショナリ。 既存のすべてのタグが上書きされます。

例外

update_creation_state

メモリ内オブジェクトの現在の状態を更新します。

対応するクラウド オブジェクトの現在の状態に基づいて、オブジェクトのプロパティのインプレース更新を実行します。 作成状態を手動でポーリングする場合に特に便利です。

update_creation_state()

例外

wait_for_creation

イメージの作成が完了するまで待機します。

イメージの作成が最終状態になるまで待機します。 到達した最終状態が失敗の場合、WebserviceException をスローします。

wait_for_creation(show_output=False)

パラメーター

show_output
bool
既定値: False

さらに詳細な出力を印刷するためのブール値のオプション。 既定値は False です。

例外