Image クラス
Azure Machine Learning イメージの抽象親クラスを定義します。
このクラスは非推奨です。 代わりに Environment クラスを使用してください。
イメージ コンストラクター。
このクラスは非推奨です。 代わりに Environment クラスを使用してください。
イメージ コンストラクターは、指定されたワークスペースに関連付けられている Image オブジェクトのクラウド表現を取得するために使用されます。 取得した Image オブジェクトの特定の型に対応する子クラスのインスタンスを返します。
- 継承
-
Image
コンストラクター
Image(workspace, name=None, id=None, tags=None, properties=None, version=None)パラメーター
| 名前 | 説明 |
|---|---|
|
workspace
必須
|
取得するイメージを含む Workspace オブジェクト。 |
|
name
|
取得するイメージの名前。 イメージの最新バージョンが存在する場合、それを返します。 規定値: None
|
|
id
|
取得するイメージの特定の ID。 (ID は "<name>:<version>" です) 規定値: None
|
|
tags
|
指定されたリストに基づいて、'key' または '[key, value]' でイメージの結果をフィルター処理します。 例: ['key', ['key2', 'key2 value']] 規定値: None
|
|
properties
|
指定されたリストに基づいて、'key' または '[key, value]' でイメージの結果をフィルター処理します。 例: ['key', ['key2', 'key2 value']] 規定値: None
|
|
version
|
バージョンと名前が両方とも指定されている場合、特定バージョンのイメージを返します。 規定値: None
|
|
workspace
必須
|
取得するイメージを含むワークスペース オブジェクト |
|
name
必須
|
取得するイメージの名前。 最新バージョンが返されます (存在する場合) |
|
id
必須
|
取得するイメージの特定の ID。 (ID は ":") |
|
tags
必須
|
指定されたリストに基づいて、'key' または '[key, value]' でイメージの結果をフィルター処理します。 例: ['key', ['key2', 'key2 value']] |
|
properties
必須
|
指定されたリストに基づいて、'key' または '[key, value]' でイメージの結果をフィルター処理します。 例: ['key', ['key2', 'key2 value']] |
|
version
必須
|
バージョンと名前が両方とも指定されている場合、特定バージョンのイメージを返します。 |
注釈
Image コンストラクターは、指定されたワークスペースに関連付けられている Image オブジェクトのクラウド表現を取得します。 取得した Image オブジェクトの特定の型に対応する子クラスのインスタンスを返します。
Image オブジェクトは、ユーザーの Model を Webservice としてデプロイするために使用されます。 Image オブジェクトには、モデル、実行スクリプト、モデル デプロイに必要な依存関係が通常は含まれます。 Image クラスには、Docker イメージ用の ContainerImage などの複数のサブクラスや、FPGA のような複数のイメージがあります。
Image クラスから継承するクラスの例については、「ContainerImage クラス」を参照してください。
Image は、イメージを使用する必要があるワークフロー内で通常は使用されます。 ほとんどのワークフローでは、代わりに Environment クラスを使用してイメージを定義する必要があります。 その後、 Model deploy() メソッドと共に Environment オブジェクトを使用して、モデルを 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
必須
|
追加するプロパティの辞書。 |
例外
| 型 | 説明 |
|---|---|
add_tags
イメージにタグを追加します。
add_tags(tags)パラメーター
| 名前 | 説明 |
|---|---|
|
tags
必須
|
追加するタグの辞書。 |
例外
| 型 | 説明 |
|---|---|
create
指定されたワークスペース内にイメージを作成します。
static create(workspace, name, models, image_config)パラメーター
| 名前 | 説明 |
|---|---|
|
workspace
必須
|
<xref:<xref:workspace: azureml.core.workspace.Workspace>>
このイメージに関連付けるワークスペース。 |
|
name
必須
|
このイメージに関連付ける名前。 |
|
models
必須
|
このイメージを使用してパッケージ化する Model オブジェクトのリスト。 空のリストを指定できます。 |
|
image_config
必須
|
このイメージの構成に使用するイメージ構成オブジェクト。 |
戻り値
| 型 | 説明 |
|---|---|
|
作成された Image オブジェクト。 |
例外
| 型 | 説明 |
|---|---|
delete
対応するワークスペースからイメージを削除します。
delete()例外
| 型 | 説明 |
|---|---|
注釈
イメージが稼働中の Web サービスにデプロイされている場合、このメソッドは失敗します。
deserialize
JSON オブジェクトを Image オブジェクトに変換します。
deserialize(workspace, image_payload)パラメーター
| 名前 | 説明 |
|---|---|
|
cls
必須
|
クラス メソッドを示します。 |
|
workspace
必須
|
イメージが登録されている Workspace オブジェクト。 |
|
image_payload
必須
|
Image オブジェクトに変換する JSON オブジェクト。 |
戻り値
| 型 | 説明 |
|---|---|
|
指定された JSON オブジェクトのイメージ表現。 |
例外
| 型 | 説明 |
|---|---|
注釈
イメージが登録されていないワークスペースを指定した場合、このメソッドは失敗します。
image_configuration
list
対応するワークスペースに関連付けられているイメージをリストします。 特定のパラメーターを使用してフィルター処理できます。
static list(workspace, image_name=None, model_name=None, model_id=None, tags=None, properties=None)パラメーター
| 名前 | 説明 |
|---|---|
|
workspace
必須
|
イメージをリストする Workspace オブジェクト。 |
|
image_name
|
特定のイメージ名を持つデプロイ済みイメージのみを含めるようにリストをフィルター処理します。 規定値: None
|
|
model_name
|
特定のモデル名を持つデプロイ済みイメージのみを含めるようにリストをフィルター処理します。 規定値: None
|
|
model_id
|
特定のモデル ID を持つデプロイ済みイメージのみを含めるようにリストをフィルター処理します。 規定値: None
|
|
tags
|
指定されたリストに基づいて、'key' または '[key, value]' でフィルター処理します。 例: ['key', ['key2', 'key2 value']] 規定値: None
|
|
properties
|
指定されたリストに基づいて、'key' または '[key, value]' でフィルター処理します。 例: ['key', ['key2', 'key2 value']] 規定値: None
|
戻り値
| 型 | 説明 |
|---|---|
|
list[<xref:Images>]
|
指定されたワークスペース内のフィルター処理されたイメージのリスト。 |
例外
| 型 | 説明 |
|---|---|
remove_tags
イメージからタグを削除します。
remove_tags(tags)パラメーター
| 名前 | 説明 |
|---|---|
|
tags
必須
|
削除するタグに対応するキーのリスト。 |
例外
| 型 | 説明 |
|---|---|
serialize
この Image オブジェクトを JSON のシリアル化されたディクショナリに変換します。
serialize()戻り値
| 型 | 説明 |
|---|---|
|
この Image オブジェクトの JSON 表現。 |
例外
| 型 | 説明 |
|---|---|
update
イメージを更新します。
update(tags)パラメーター
| 名前 | 説明 |
|---|---|
|
tags
必須
|
イメージの更新時に使用するタグのディクショナリ。 既存のすべてのタグが上書きされます。 |
例外
| 型 | 説明 |
|---|---|
update_creation_state
メモリ内オブジェクトの現在の状態を更新します。
対応するクラウド オブジェクトの現在の状態に基づいて、オブジェクトのプロパティのインプレース更新を実行します。 作成状態を手動でポーリングする場合に特に便利です。
update_creation_state()例外
| 型 | 説明 |
|---|---|
wait_for_creation
イメージの作成が完了するまで待機します。
イメージの作成が最終状態になるまで待機します。 到達した最終状態が失敗の場合、WebserviceException をスローします。
wait_for_creation(show_output=False)パラメーター
| 名前 | 説明 |
|---|---|
|
show_output
|
より詳細な情報を出力するためのブール値のオプション。 既定値は False です。 規定値: False
|
例外
| 型 | 説明 |
|---|---|