ContainerImageConfig クラス
コンテナーのデプロイに固有のイメージ構成設定を定義します。実行スクリプトとランタイムが必要です。
一般的なユース ケースでは、ContainerImage クラスの image_configuration
メソッドを使用して ContainerImageConfig オブジェクトを作成します。
config オブジェクトを初期化します。
- 継承
-
ContainerImageConfig
コンストラクター
ContainerImageConfig(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, allow_absolute_path=False, cuda_version=None)
パラメーター
名前 | 説明 |
---|---|
execution_script
必須
|
イメージに対して実行するコードが含まれているローカル ファイルへのパス。 |
runtime
必須
|
イメージに使用するランタイム。 現在サポートされているランタイムは "spark-py" と "python" です。 |
conda_file
|
イメージに使用する Conda 環境定義が含まれているローカル ファイルへのパス。 規定値: None
|
docker_file
|
イメージを設定するときに実行する追加の Docker 手順が含まれているローカル ファイルへのパス。 規定値: None
|
schema_file
|
イメージがデプロイされるときに使用する webservice スキーマが含まれているローカル ファイルへのパス。 規定値: None
|
dependencies
|
イメージで実行する必要がある追加のファイルまたはフォルダーのパスのリスト。 規定値: None
|
enable_gpu
|
イメージで GPU サポートを有効にするかどうか。 GPU イメージは、Azure Container Instances、Azure Machine Learning コンピューティング、Azure Virtual Machines、Azure Kubernetes Service などの Microsoft Azure サービス上で使用する必要があります。 既定値は False です。 規定値: None
|
tags
|
このイメージに提供するキー値タグの辞書。 規定値: None
|
properties
|
このイメージに提供するキー値プロパティの辞書。 これらのプロパティはデプロイ後は変更できません。ただし、新しいキー値のペアを追加することはできます。 規定値: None
|
description
|
このイメージに付与する説明。 規定値: None
|
base_image
|
基本イメージとして使用するカスタム イメージ。 基本イメージが指定されていない場合、基本イメージは、指定されたランタイム パラメーターに基づいて使用されます。 規定値: None
|
base_image_registry
|
基本イメージを含むイメージ レジストリ。 規定値: None
|
allow_absolute_path
|
絶対パスを許可するかどうかを示します。 規定値: False
|
cuda_version
|
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" です。 規定値: None
|
execution_script
必須
|
イメージに対して実行するコードを含むローカル ファイルへのパス |
runtime
必須
|
イメージに使用するランタイム。 現在サポートされているランタイムは、'spark-py' と 'python' です |
conda_file
必須
|
イメージに使用する conda 環境定義を含むローカル ファイルへのパス |
docker_file
必須
|
イメージの設定時に実行する追加の Docker ステップを含むローカル ファイルへのパス |
schema_file
必須
|
イメージのデプロイ時に使用する Web サービス スキーマを含むローカル ファイルへのパス |
dependencies
必須
|
イメージを実行する必要がある追加のファイル/フォルダーへのパスの一覧 |
enable_gpu
必須
|
イメージで GPU サポートを有効にするかどうか。 GPU イメージは、Azure Container Instances、Azure Machine Learning コンピューティング、Azure Virtual Machines、Azure Kubernetes Service などの Microsoft Azure サービス上で使用する必要があります。 既定値は false です。 |
tags
必須
|
この画像を与えるキー値タグの辞書 |
properties
必須
|
このイメージに提供するキー値プロパティの辞書。 これらのプロパティはデプロイ後に変更することはできませんが、新しいキーと値のペアを追加できます。 |
description
必須
|
この画像を提供する説明 |
base_image
必須
|
基本イメージとして使用するカスタム イメージ。 基本イメージが指定されていない場合、指定されたランタイム パラメーターに基づいた基本イメージが使用されます。 |
base_image_registry
必須
|
基本イメージを含むイメージ レジストリ。 |
allow_absolute_path
必須
|
絶対パスを許可するフラグ |
cuda_version
必須
|
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" です。 |
メソッド
build_create_payload |
コンテナー イメージの作成ペイロードをビルドします。 |
create_local_debug_payload |
コンテナー イメージの作成ペイロードをビルドします。 |
validate_configuration |
指定された構成値が有効であることを確認します。 検証が失敗した場合、:class:azureml.exceptions.WebserviceException` を発生させます。 |
build_create_payload
コンテナー イメージの作成ペイロードをビルドします。
build_create_payload(workspace, name, model_ids)
パラメーター
名前 | 説明 |
---|---|
workspace
必須
|
イメージを作成するワークスペース オブジェクト。 |
name
必須
|
イメージの名前。 |
model_ids
必須
|
イメージにパッケージ化するモデル ID のリスト。 |
戻り値
型 | 説明 |
---|---|
コンテナー イメージの作成ペイロード。 |
例外
型 | 説明 |
---|---|
create_local_debug_payload
コンテナー イメージの作成ペイロードをビルドします。
create_local_debug_payload(workspace, model_ids)
パラメーター
名前 | 説明 |
---|---|
workspace
必須
|
イメージを作成するワークスペース オブジェクト。 |
model_ids
必須
|
イメージにパッケージ化するモデル ID のリスト。 |
戻り値
型 | 説明 |
---|---|
コンテナー イメージの作成ペイロード。 |
例外
型 | 説明 |
---|---|
validate_configuration
指定された構成値が有効であることを確認します。
検証が失敗した場合、:class:azureml.exceptions.WebserviceException` を発生させます。
validate_configuration()
例外
型 | 説明 |
---|---|