ContainerImage クラス

  • リファレンス

コンテナー イメージを表します。現在は Docker イメージ専用です。

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

イメージには、次のような、モデルの実行に必要な依存関係が含まれています。

  • ランタイム

  • Conda ファイルで指定された Python 環境定義

  • GPU サポートを有効にする機能

  • 特定の実行コマンド用のカスタム Docker ファイル

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

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

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

継承
Image
ContainerImage

コンストラクター

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

パラメーター

workspace
Workspace
必須

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

name
str
既定値: None

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

id
str
既定値: None

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

tags
list
既定値: None

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

properties
list
既定値: None

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

version
str
既定値: None

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

注釈

ContainerImage を取得するには、以前に作成した ContainerImage の名前または ID を渡して Image クラス コンストラクターを使用します。 次のコード例は、名前と ID の両方を使用してワークスペースからイメージを取得する方法を示しています。


   container_image_from_name = Image(workspace, name="image-name")
   container_image_from_id = Image(workspace, id="image-id")

デプロイで使用する新しいイメージ構成を作成するには、次のコード例に示すように ContainerImageConfig オブジェクトをビルドします。


   from azureml.core.image import ContainerImage

   image_config = ContainerImage.image_configuration(execution_script="score.py",
                                                    runtime="python",
                                                    conda_file="myenv.yml",
                                                    description="image for model",
                                                    cuda_version="9.0"
                                                    )

メソッド

image_configuration

ContainerImageConfig オブジェクトを作成して返します。

この関数は、Webservice 内でモデルを実行する方法と、実行に必要な特定の環境および依存関係を定義するパラメーターを受け取ります。
run

指定された入力データを使用してイメージをローカルで実行します。

動作するには、Docker がインストールされ、実行されている必要があります。 GPU 対応イメージは Microsoft Azure サービスでしか実行できないため、この方法は CPU でのみ有効です。
serialize

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

image_configuration

ContainerImageConfig オブジェクトを作成して返します。

この関数は、Webservice 内でモデルを実行する方法と、実行に必要な特定の環境および依存関係を定義するパラメーターを受け取ります。

static image_configuration(execution_script, runtime, conda_file=None, docker_file=None, schema_file=None, dependencies=None, enable_gpu=None, tags=None, properties=None, description=None, base_image=None, base_image_registry=None, cuda_version=None)

パラメーター

execution_script
str
必須

イメージに対して実行するコードを含むローカル Python ファイルのパス。 Webservice のモデル実行ステップを定義する init() と run(input_data) の両方の関数を含める必要があります。

runtime
str
必須

イメージに使用するランタイム。 現在サポートされているランタイムは "spark-py" と "python" です。

conda_file
str
既定値: None

イメージに使用する Conda 環境定義を含むローカル .yml ファイルのパス。

docker_file
str
既定値: None

イメージを設定するときに実行する追加の Docker 手順を含むローカル ファイルのパス。

schema_file
str
既定値: None

イメージをデプロイするときに使用する webservice スキーマを含むローカル ファイルのパス。 モデル デプロイのための Swagger 仕様を生成するために使用されます。

dependencies
list[str]
既定値: None

イメージで実行する必要がある追加のファイルまたはフォルダーのパスのリスト。

enable_gpu
bool
既定値: None

イメージで GPU サポートを有効にするかどうか。 GPU イメージは、Azure Container Instances、Azure Machine Learning コンピューティング、Azure Virtual Machines、Azure Kubernetes Service などの Microsoft Azure サービス上で使用する必要があります。 既定値は False です

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

このイメージに提供するキー値タグの辞書。

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

このイメージに提供するキー値プロパティの辞書。 これらのプロパティはデプロイ後に変更することはできませんが、新しいキーと値のペアを追加できます。

description
str
既定値: None

このイメージに対するテキスト説明。

base_image
str
既定値: None

基本イメージとして使用するカスタム イメージ。 基本イメージが指定されていない場合、指定されたランタイム パラメーターに基づいた基本イメージが使用されます。

base_image_registry
ContainerRegistry
既定値: None

基本イメージを含むイメージ レジストリ。

cuda_version
str
既定値: None

GPU のサポートが必要なイメージにインストールする CUDA のバージョン。 GPU イメージは、Azure Container Instances、Azure Machine Learning コンピューティング、Azure Virtual Machines、Azure Kubernetes Service などの Microsoft Azure サービス上で使用する必要があります。 サポートされているバージョンは 9.0、9.1、10.0 です。 "enable_gpu" が設定されている場合、これの既定値は "9.1" です。

戻り値

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

の戻り値の型 :

ContainerImageConfig

例外

WebserviceException

run

指定された入力データを使用してイメージをローカルで実行します。

動作するには、Docker がインストールされ、実行されている必要があります。 GPU 対応イメージは Microsoft Azure サービスでしか実行できないため、この方法は CPU でのみ有効です。

run(input_data)

パラメーター

input_data
<xref:varies>
必須

実行時にイメージに渡す入力データ

戻り値

イメージの実行結果。

の戻り値の型 :

<xref:varies>

例外

WebserviceException

serialize

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

serialize()

戻り値

この ContainerImage の JSON 表現。

の戻り値の型 :

dict

例外

WebserviceException