ModelPackage クラス

Docker イメージまたは Dockerfile への 1 つ以上のモデルとそれらの依存関係のパッケージ化を表します。

ModelPackage オブジェクトは、Model クラスの package メソッドから返されます。 パッケージ メソッドの generate_dockerfile パラメーターによって、Docker イメージまたは Dockerfile が作成されるかどうかが決まります。

モデルと依存関係を使用して作成されたパッケージを初期化します。

継承
builtins.object
ModelPackage

コンストラクター

ModelPackage(workspace, operation_id, environment)

パラメーター

名前 説明
workspace
必須

パッケージが存在するワークスペース。

operation_id
必須
str

パッケージ作成操作の ID。

environment
必須

モデルがパッケージ化される環境。

workspace
必須

パッケージが存在するワークスペース。

operation_id
必須
str

パッケージ作成操作の ID。

environment
必須

モデルがパッケージ化される環境。

注釈

モデルとその依存関係をカプセル化する Docker イメージを構築するために、モデル パッケージ オプションを使用できます。 出力イメージは、ワークスペースの ACR にプッシュされます。

Model パッケージ メソッドを使用するには、推論構成に Environment オブジェクトを含める必要があります。


   package = Model.package(ws, [model], inference_config)
   package.wait_for_creation(show_output=True)  # Or show_output=False to hide the Docker build logs.
   package.pull()

完全に構築されたイメージの代わりに、Dockerfile を生成し、環境の上にイメージを構築するために必要なすべてのアセットをダウンロードできます。


   package = Model.package(ws, [model], inference_config, generate_dockerfile=True)
   package.wait_for_creation(show_output=True)
   package.save("./local_context_dir")

変数

名前 説明
azureml.core.model.ModelPackage.workspace

パッケージが作成されるワークスペース。

メソッド

get_container_registry

イメージまたは基本イメージ (Dockerfile パッケージ) が格納される場所を示す ContainerRegistry オブジェクトを返します。

get_logs

パッケージ作成ログを取得します。

pull

パッケージの出力をローカル コンピューターにプルします。

これは Docker イメージ パッケージでのみ使用できます。

save

パッケージ出力をローカル ディレクトリに保存します。

これは Dockerfile パッケージでのみ使用できます。

serialize

CLI で表示するために、この ModelPackage を JSON シリアル化可能なディクショナリに変換します。

update_creation_state

メモリ内オブジェクトの現在の状態を更新します。

このメソッドでは、対応するクラウド オブジェクトの現在の状態に基づいて、オブジェクトのプロパティのインプレース更新を実行します。 これは主に、作成状態の手動ポーリングに使用されます。

wait_for_creation

パッケージの作成が完了するまで待機します。

このメソッドは、パッケージの作成がターミナル状態に達するまで待機します。 失敗したターミナル状態に達した場合は WebserviceException がスローされます。

get_container_registry

イメージまたは基本イメージ (Dockerfile パッケージ) が格納される場所を示す ContainerRegistry オブジェクトを返します。

get_container_registry()

戻り値

説明

コンテナー レジストリのアドレスとログイン資格情報。

get_logs

パッケージ作成ログを取得します。

get_logs(decode=True, offset=0)

パラメーター

名前 説明
decode

生のログ バイトを文字列にデコードするかどうかを示します。

規定値: True
offset
int

ログの読み取り開始位置のバイト オフセット。

規定値: 0

戻り値

説明
str

パッケージ作成ログ。

例外

説明

pull

パッケージの出力をローカル コンピューターにプルします。

これは Docker イメージ パッケージでのみ使用できます。

pull()

例外

説明

save

パッケージ出力をローカル ディレクトリに保存します。

これは Dockerfile パッケージでのみ使用できます。

save(output_directory)

パラメーター

名前 説明
output_directory
必須
str

パッケージの内容を格納するために作成されるローカル ディレクトリ。

例外

説明

serialize

CLI で表示するために、この ModelPackage を JSON シリアル化可能なディクショナリに変換します。

serialize()

戻り値

説明

この ModelPackage の JSON 表現。

update_creation_state

メモリ内オブジェクトの現在の状態を更新します。

このメソッドでは、対応するクラウド オブジェクトの現在の状態に基づいて、オブジェクトのプロパティのインプレース更新を実行します。 これは主に、作成状態の手動ポーリングに使用されます。

update_creation_state()

例外

説明

wait_for_creation

パッケージの作成が完了するまで待機します。

このメソッドは、パッケージの作成がターミナル状態に達するまで待機します。 失敗したターミナル状態に達した場合は WebserviceException がスローされます。

wait_for_creation(show_output=False)

パラメーター

名前 説明
show_output

より詳細な出力を印刷するかどうかを示します。

規定値: False

例外

説明