AciWebservice クラス

リファレンス

Azure Container Instances 上に Web サービスエンドポイントとしてデプロイされた機械学習モデルを表します。

デプロイされたサービスは、モデル、スクリプト、関連ファイルから作成されます。結果として得られる Web サービスは、REST API を備えた、負荷分散された HTTP エンドポイントです。この API にデータを送信し、モデルによって返される予測を受信できます。

詳細については、Azure Container Instances へのモデルのデプロイに関するページを参照してください。

Webservice インスタンスを初期化します。

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

継承: Webservice

AciWebservice

コンストラクター

AciWebservice(workspace, name)

パラメーター

名前	説明
workspace 必須	Workspace 取得する Webservice オブジェクトを含むワークスペースオブジェクト。
name 必須	str 取得する Webservice オブジェクトの名前。

注釈

推奨されるデプロイパターンは、deploy_configuration メソッドを使用してデプロイ構成オブジェクトを作成し、次に示すように Model クラスの deploy メソッドと一緒にそれを使用します。


   from azureml.core.model import InferenceConfig
   from azureml.core.webservice import AciWebservice


   service_name = 'my-custom-env-service'

   inference_config = InferenceConfig(entry_script='score.py', environment=environment)
   aci_config = AciWebservice.deploy_configuration(cpu_cores=1, memory_gb=1)

   service = Model.deploy(workspace=ws,
                          name=service_name,
                          models=[model],
                          inference_config=inference_config,
                          deployment_config=aci_config,
                          overwrite=True)
   service.wait_for_deployment(show_output=True)

Webservice としてモデルをデプロイするには、次のようなさまざまな方法があります。

ワークスペースに既に登録されているモデルの Model の deploy メソッド。
Webservice の deploy_from_image メソッド。
ワークスペースに既に登録されているモデルの Webservice の deploy_from_model メソッド。このメソッドは、イメージを作成します。
モデルを登録し、イメージを作成する Webservice の deploy メソッド。

Webservice の使用方法の詳細については、次を参照してください

"変数" セクションに、クラウド AciWebservice オブジェクトのローカル表現の属性を一覧表示します。これらの変数は読み取り専用と見なされます。値を変更しても、対応するクラウドオブジェクトには反映されません。

変数

名前	説明
enable_app_insights	bool Webservice に対して AppInsights のログが有効になっているかどうか。
cname	str Webservice の cname。
container_resource_requirements	ContainerResourceRequirements Webservice のコンテナーリソース要件。
encryption_properties	EncryptionProperties Webservice の暗号化プロパティ。
vnet_configuration	VnetConfiguration Webservice の仮想ネットワークプロパティ。ユーザーが構成を作成して指定する必要があります。
azureml.core.webservice.AciWebservice.location	str Webservice がデプロイされる場所。
public_ip	str Webservice のパブリック IP アドレス。
azureml.core.webservice.AciWebservice.scoring_uri	str Webservice のスコアリングエンドポイント
ssl_enabled	bool Webservice の SSL が有効かどうか。
public_fqdn	str Webservice のパブリック FQDN。
environment	Environment Webservice の作成に使用された Environment オブジェクト。
azureml.core.webservice.AciWebservice.models	list[Model] Webservice にデプロイされた Model の一覧。
azureml.core.webservice.AciWebservice.swagger_uri	str Webservice の swagger エンドポイント。

メソッド

add_properties	この Webservice のプロパティ辞書にキーと値のペアを追加します。
add_tags	この Webservice のタグ辞書にキーと値のペアを追加します。
deploy_configuration	AciWebservice をデプロイするための構成オブジェクトを作成します。
get_token	この Webservice の認証トークンを取得します。範囲は現在のユーザーに設定されます。 Note 実装されていません。
remove_tags	この Webservice のタグの辞書から、指定されたキーを削除します。
run	指定された入力でこの Webservice を呼び出します。
serialize	この Webservice を JSON シリアル化された辞書に変換します。
update	指定されたプロパティで Webservice を更新します。 None のままの値は、この Webservice では変更されません。

add_properties

この Webservice のプロパティ辞書にキーと値のペアを追加します。

add_properties(properties)

パラメーター

名前	説明
properties 必須	dict[str, str] 追加するプロパティの辞書。

add_tags

この Webservice のタグ辞書にキーと値のペアを追加します。

add_tags(tags)

パラメーター

名前	説明
tags 必須	dict[str, str] 追加するタグの辞書。

例外

型	説明
WebserviceException

deploy_configuration

AciWebservice をデプロイするための構成オブジェクトを作成します。

static deploy_configuration(cpu_cores=None, memory_gb=None, tags=None, properties=None, description=None, location=None, auth_enabled=None, ssl_enabled=None, enable_app_insights=None, ssl_cert_pem_file=None, ssl_key_pem_file=None, ssl_cname=None, dns_name_label=None, primary_key=None, secondary_key=None, collect_model_data=None, cmk_vault_base_url=None, cmk_key_name=None, cmk_key_version=None, vnet_name=None, subnet_name=None)

パラメーター

名前	説明
cpu_cores	float この Webservice に割り当てる CPU コアの数。 10 進数を指定できます。既定値は 0.1 です規定値: None
memory_gb	float この Web サービスに割り当てるメモリの量 (GB 単位)。 10 進数を指定できます。既定値は 0.5 です規定値: None
tags	dict[str, str] この Web サービスに提供するキー値タグのディクショナリ。規定値: None
properties	dict[str, str] この Web サービスに提供するキー値プロパティのディクショナリ。これらのプロパティはデプロイ後に変更することはできませんが、新しいキーと値のペアを追加できます。規定値: None
description	str この Web サービスに提供する説明。規定値: None
location	str この Web サービスのデプロイ先となる Azure リージョン。指定されていない場合、ワークスペースの場所が使用されます。使用可能なリージョンの詳細については、リージョン別の製品に関するページを参照してください。規定値: None
auth_enabled	bool この Web サービスに対して認証を有効にするかどうか。既定値は False です。規定値: None
ssl_enabled	bool この Web サービスに対して SSL を有効にするかどうか。既定値は False です。規定値: None
enable_app_insights	bool この Web サービスに対して AppInsights を有効にするかどうか。既定値は False です。規定値: None
ssl_cert_pem_file	str SSL が有効な場合、証明書ファイルが必要です。規定値: None
ssl_key_pem_file	str SSL が有効な場合、キーファイルが必要です。規定値: None
ssl_cname	str SSL が有効な場合の cname 規定値: None
dns_name_label	str スコアリングエンドポイントの DNS 名ラベル。指定されていない場合、一意の DNS 名ラベルがスコアリングエンドポイントに対して生成されます。規定値: None
primary_key	str この Webservice に使用するプライマリ認証キー。規定値: None
secondary_key	str この Webservice に使用するセカンダリ認証キー。規定値: None
collect_model_data	bool Webservice に対してモデルデータ収集を有効にするかどうかを指定します。規定値: None
cmk_vault_base_url	str カスタマーマネージドキーコンテナーのベース URL 規定値: None
cmk_key_name	str カスタマーマネージドキーの名前。規定値: None
cmk_key_version	str カスタマーマネージドキーのバージョン。規定値: None
vnet_name	str 仮想ネットワークの名前。規定値: None
subnet_name	str 仮想ネットワーク内のサブネット名。規定値: None

戻り値

型	説明
AciServiceDeploymentConfiguration	Webservice オブジェクトをデプロイするときに使用する構成オブジェクト。

例外

型	説明
WebserviceException

get_token

この Webservice の認証トークンを取得します。範囲は現在のユーザーに設定されます。

Note

実装されていません。

get_token()

戻り値

型	説明
str, datetime	この Webservice の認証トークンと、後で更新する必要があるタイミング。

例外

型	説明
azureml.exceptions.NotImplementedError

remove_tags

この Webservice のタグの辞書から、指定されたキーを削除します。

remove_tags(tags)

パラメーター

名前	説明
tags 必須	list[str] 削除するキーのリスト。

run

指定された入力でこの Webservice を呼び出します。

run(input_data)

パラメーター

名前	説明
input_data 必須	<xref:varies> Webservice を呼び出す際に使用する入力。

戻り値

型	説明
dict	Webservice を呼び出した結果。

例外

型	説明
WebserviceException

serialize

この Webservice を JSON シリアル化された辞書に変換します。

serialize()

戻り値

型	説明
dict	この Webservice オブジェクトの JSON 表現。

update

指定されたプロパティで Webservice を更新します。

None のままの値は、この Webservice では変更されません。

update(image=None, tags=None, properties=None, description=None, auth_enabled=None, ssl_enabled=None, ssl_cert_pem_file=None, ssl_key_pem_file=None, ssl_cname=None, enable_app_insights=None, models=None, inference_config=None)

パラメーター

名前	説明
image	Image Webservice にデプロイする新しいイメージ。規定値: None
tags	dict[str, str] この Webservice に提供するキー値タグのディクショナリ。既存のタグを置き換えます。規定値: None
properties	dict[str, str] 既存のプロパティディクショナリに追加するキー値プロパティのディクショナリ。規定値: None
description	str この Webservice に提供する説明。規定値: None
auth_enabled	bool この Webservice に対して認証を有効または無効にします。規定値: None
ssl_enabled	bool この Web サービスに対して SSL を有効にするかどうか。規定値: None
ssl_cert_pem_file	str SSL が有効な場合、証明書ファイルが必要です。規定値: None
ssl_key_pem_file	str SSL が有効な場合、キーファイルが必要です。規定値: None
ssl_cname	str SSL が有効な場合の cname 規定値: None
enable_app_insights	bool この Web サービスに対して AppInsights を有効にするかどうか。規定値: None
models	list[Model] 更新されたサービスにパッケージ化する Model オブジェクトのリスト。規定値: None
inference_config	InferenceConfig 必要なモデルデプロイプロパティを提供するために使用される InferenceConfig オブジェクト。規定値: None

戻り値

型	説明
None

次の方法で共有

AciWebservice クラス

コンストラクター

パラメーター

注釈

変数

メソッド

add_properties

パラメーター

add_tags

パラメーター

例外

deploy_configuration

パラメーター

戻り値

例外

get_token

戻り値

例外

remove_tags

パラメーター

run

パラメーター

戻り値

例外

serialize

戻り値

update

パラメーター

戻り値

フィードバック

その他のリソース