Image クラス
Azure Machine Learning イメージの抽象親クラスを定義します。
このクラスは非推奨です。 代わりに Environment クラスを使用してください。
イメージ コンストラクター。
このクラスは非推奨です。 代わりに Environment クラスを使用してください。
イメージ コンストラクターは、指定されたワークスペースに関連付けられている Image オブジェクトのクラウド表現を取得するために使用されます。 取得した Image オブジェクトの特定の型に対応する子クラスのインスタンスを返します。
コンストラクター
Image(workspace, name=None, id=None, tags=None, properties=None, version=None)パラメーター
| 名前 | 説明 |
|---|---|
|
workspace
必須
|
取得するイメージを含む Workspace オブジェクト。 |
|
name
|
取得するイメージの名前。 存在する場合は、最新バージョンの Image が返されます。 規定値: 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 は "<name>:<version>" です) |
|
tags
必須
|
指定されたリストに基づいて、'key' または '[key, value]' で画像の結果をフィルター処理します。 例: ['key', ['key2', 'key2 value']] |
|
properties
必須
|
指定されたリストに基づいて、'key' または '[key, value]' で画像の結果をフィルター処理します。 例: ['key', ['key2', 'key2 value']] |
|
version
必須
|
バージョンと名前の両方を指定すると、イメージの特定のバージョンが返されます。 |
注釈
Image コンストラクターは、指定されたワークスペースに関連付けられた Image オブジェクトのクラウド表現を取得します。 取得した Image オブジェクトの特定の型に対応する子クラスのインスタンスを返します。
Image オブジェクトは、ユーザーの Model を Webserviceとしてデプロイするために使用されます。 Image オブジェクトには、通常、Model、実行スクリプト、およびモデルのデプロイに必要な依存関係が含まれます。 Image クラスには、Docker イメージ用の ContainerImage や FPGA などのイメージなどの複数のサブクラスがあります。
Image クラスから継承するクラスの例については、 ContainerImage クラスを参照してください。
イメージは、通常、イメージの使用を必要とするワークフローで使用されます。 ほとんどのワークフローでは、代わりに Environment クラスを使用してイメージを定義する必要があります。 その後、 Modeldeploy() メソッドと共に Environment オブジェクトを使用して、モデルを Web サービスとしてデプロイできます。
Model package() メソッドを使用して、ローカルの Docker インストールにイメージまたは Dockerfile としてダウンロードできるイメージを作成することもできます。
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
必須
|
イメージが登録されているワークスペース オブジェクト。 |
|
image_payload
必須
|
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 オブジェクト。 |
|
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
update
イメージを更新します。
update(tags)パラメーター
| 名前 | 説明 |
|---|---|
|
tags
必須
|
イメージを更新するタグのディクショナリ。 既存のタグを上書きします。 |
例外
| 型 | 説明 |
|---|---|
update_creation_state
メモリ内オブジェクトの現在の状態を更新します。
対応するクラウド オブジェクトの現在の状態に基づいて、オブジェクトのプロパティのインプレース更新を実行します。 主に、作成状態の手動ポーリングに役立ちます。
update_creation_state()例外
| 型 | 説明 |
|---|---|
wait_for_creation
イメージの作成が完了するまで待ちます。
イメージの作成が終了状態になるまで待ちます。 正常でない終了状態に達した場合、WebserviceException をスローします。
wait_for_creation(show_output=False)パラメーター
| 名前 | 説明 |
|---|---|
|
show_output
|
より詳細な出力を出力するブール型オプション。 既定値は False です。 規定値: False
|
例外
| 型 | 説明 |
|---|---|