ContainerImage クラス
コンテナー イメージを表します。現在は Docker イメージの場合のみです。
このクラスは非推奨です。 代わりに Environment クラスを使用してください。
このイメージには、次のようなモデルの実行に必要な依存関係が含まれています。
ランタイム
Conda ファイルで指定された Python 環境定義
GPU サポートを有効にする機能
特定の実行コマンド用のカスタム Docker ファイル
イメージ コンストラクター。
このクラスは非推奨です。 代わりに Environment クラスを使用してください。
イメージ コンストラクターは、指定されたワークスペースに関連付けられている Image オブジェクトのクラウド表現を取得するために使用されます。 取得した Image オブジェクトの特定の型に対応する子クラスのインスタンスを返します。
コンストラクター
ContainerImage(workspace, name=None, id=None, tags=None, properties=None, version=None)パラメーター
| 名前 | 説明 |
|---|---|
|
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
|
注釈
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 オブジェクトを作成して返します。 この関数は、Web サービス内でのモデルの実行方法、および実行できる必要がある特定の環境と依存関係を定義するためのパラメーターを受け取ります。 |
| run |
指定された入力データを使用して、イメージをローカルで実行します。 動作させるには、Docker がインストールされ、実行されている必要があります。 GPU 対応イメージは Microsoft Azure Services でのみ実行できるため、この方法は CPU でのみ機能します。 |
| serialize |
この ContainerImage オブジェクトを JSON シリアル化ディクショナリに変換します。 |
image_configuration
ContainerImageConfig オブジェクトを作成して返します。
この関数は、Web サービス内でのモデルの実行方法、および実行できる必要がある特定の環境と依存関係を定義するためのパラメーターを受け取ります。
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
必須
|
イメージに対して実行するコードを含むローカル Python ファイルへのパス。 Web サービスのモデル実行手順を定義する init() 関数と run(input_data) 関数の両方を含める必要があります。 |
|
runtime
必須
|
イメージに使用するランタイム。 現在サポートされているランタイムは、'spark-py' と 'python' です。 |
|
conda_file
|
イメージに使用する Conda 環境定義を含むローカル .yml ファイルへのパス。 規定値: None
|
|
docker_file
|
イメージの設定時に実行する追加の Docker ステップを含むローカル ファイルへのパス。 規定値: None
|
|
schema_file
|
イメージのデプロイ時に使用する Web サービス スキーマを含むローカル ファイルへのパス。 モデル デプロイの Swagger スペックを生成するために使用されます。 規定値: None
|
|
dependencies
|
イメージを実行する必要がある追加のファイル/フォルダーへのパスの一覧。 規定値: None
|
|
enable_gpu
|
イメージで GPU サポートを有効にするかどうかを指定します。 GPU イメージは、Azure Container Instances、Azure Machine Learning Compute、Azure Virtual Machines、Azure Kubernetes Service などの Microsoft Azure サービスで使用する必要があります。 既定値は False です 規定値: None
|
|
tags
|
この画像を提供するキー値タグのディクショナリ。 規定値: None
|
|
properties
|
このイメージを提供するキー値プロパティのディクショナリ。 これらのプロパティはデプロイ後に変更できませんが、新しいキーと値のペアを追加できます。 規定値: None
|
|
description
|
この画像を提供するテキストの説明。 規定値: None
|
|
base_image
|
基本イメージとして使用するカスタム イメージ。 基本イメージが指定されていない場合は、指定されたランタイム パラメーターに基づいて基本イメージが使用されます。 規定値: None
|
|
base_image_registry
|
基本イメージを含むイメージ レジストリ。 規定値: None
|
|
cuda_version
|
GPU サポートが必要なイメージ用にインストールする CUDA のバージョン。 GPU イメージは、Azure Container Instances、Azure Machine Learning Compute、Azure Virtual Machines、Azure Kubernetes Service などの Microsoft Azure サービスで使用する必要があります。 サポートされているバージョンは 9.0、9.1、10.0 です。 'enable_gpu' が設定されている場合、既定値は '9.1' になります。 規定値: None
|
戻り値
| 型 | 説明 |
|---|---|
|
イメージの作成時に使用する構成オブジェクト。 |
例外
| 型 | 説明 |
|---|---|
run
指定された入力データを使用して、イメージをローカルで実行します。
動作させるには、Docker がインストールされ、実行されている必要があります。 GPU 対応イメージは Microsoft Azure Services でのみ実行できるため、この方法は CPU でのみ機能します。
run(input_data)パラメーター
| 名前 | 説明 |
|---|---|
|
input_data
必須
|
<xref:varies>
実行時にイメージに渡す入力データ |
戻り値
| 型 | 説明 |
|---|---|
|
<xref:varies>
|
イメージを実行した結果。 |
例外
| 型 | 説明 |
|---|---|
serialize
この ContainerImage オブジェクトを JSON シリアル化ディクショナリに変換します。
serialize()戻り値
| 型 | 説明 |
|---|---|
|
この ContainerImage の JSON 表記。 |