AciWebservice クラス
Azure Container Instances 上の Web サービス エンドポイントとしてデプロイされた機械学習モデルを表します。
デプロイされたサービスは、モデル、スクリプト、および関連ファイルから作成されます。 結果として得られる Web サービスは、REST API を使用して負荷分散された HTTP エンドポイントです。 この API にデータを送信し、モデルによって返された予測を受け取ることができます。
詳細については、Azure Container Instances へのモデルのデプロイに関するページを参照してください。
Web サービス インスタンスを初期化します。
Web サービス コンストラクターは、指定されたワークスペースに関連付けられている Web サービス オブジェクトのクラウド表現を取得します。 取得した Web サービス オブジェクトの特定の型に対応する子クラスのインスタンスが返されます。
コンストラクター
AciWebservice(workspace, name)
パラメーター
名前 | 説明 |
---|---|
workspace
必須
|
取得する Web サービス オブジェクトを含むワークスペース オブジェクト。 |
name
必須
|
取得する Web サービス オブジェクトの名前。 |
注釈
推奨されるデプロイ パターンは、deploy_configuration
メソッドを使用してデプロイ構成オブジェクトを作成し、次に示すように、deploy
クラスのModel メソッドでそれを使用することです。
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)
Web サービスとしてモデルをデプロイするには、次のようなさまざまな方法があります。
deploy
ワークスペースに既に登録されているモデルの Model のメソッド。deploy_from_image
Webserviceのメソッド。deploy_from_model
ワークスペースに既に登録されているモデルの Webservice メソッド。 このメソッドはイメージを作成します。deploy
モデルを登録してイメージを作成する Webserviceのメソッド。
Web サービスの操作については、以下を参照してください。
[変数] セクションには、クラウド AciWebservice オブジェクトのローカル表現の属性が一覧表示されます。 これらの変数は読み取り専用と見なす必要があります。 値の変更は、対応するクラウド オブジェクトには反映されません。
変数
名前 | 説明 |
---|---|
enable_app_insights
|
Web サービスに対して AppInsights ログが有効かどうか。 |
cname
|
Web サービスの cname。 |
container_resource_requirements
|
Web サービスのコンテナー リソース要件。 |
encryption_properties
|
Web サービスの暗号化プロパティ。 |
vnet_configuration
|
Web サービスの仮想ネットワーク プロパティ、構成を作成し、ユーザーが提供する必要があります。 |
azureml.core.webservice.AciWebservice.___location
|
Web サービスの展開先の場所。 |
public_ip
|
Web サービスのパブリック IP アドレス。 |
azureml.core.webservice.AciWebservice.scoring_uri
|
Web サービスのスコアリング エンドポイント |
ssl_enabled
|
Web サービスに対して SSL が有効かどうか |
public_fqdn
|
Web サービスのパブリック FQDN |
environment
|
Web サービスの作成に使用された Environment オブジェクト |
azureml.core.webservice.AciWebservice.models
|
Web サービスにデプロイされたモデルの一覧 |
azureml.core.webservice.AciWebservice.swagger_uri
|
Web サービスの swagger エンドポイント |
メソッド
add_properties |
この Web サービスのプロパティ ディクショナリにキー値ペアを追加します。 |
add_tags |
この Web サービスのタグ ディクショナリにキー値ペアを追加します。 |
deploy_configuration |
AciWebservice をデプロイするための構成オブジェクトを作成します。 |
get_token |
現在のユーザーにスコープを設定して、この Web サービスの認証トークンを取得します。 注 実装されていません。 |
remove_tags |
この Web サービスのタグディクショナリから、指定したキーを削除します。 |
run |
指定された入力でこの Web サービスを呼び出します。 |
serialize |
この Web サービスを JSON シリアル化ディクショナリに変換します。 |
update |
指定されたプロパティを使用して Web サービスを更新します。 [なし] のままにした値は、この Web サービスでは変更されません。 |
add_properties
add_tags
この Web サービスのタグ ディクショナリにキー値ペアを追加します。
add_tags(tags)
パラメーター
名前 | 説明 |
---|---|
tags
必須
|
追加するタグのディクショナリ。 |
例外
型 | 説明 |
---|---|
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
|
この Web サービスに割り当てる CPU コアの数。 10 進数を指定できます。 既定値は 0.1 規定値: None
|
memory_gb
|
この Web サービスに割り当てるメモリの量 (GB 単位)。 10 進数を指定できます。 既定値は 0.5 規定値: None
|
tags
|
この Web サービスを提供するキー値タグのディクショナリ。 規定値: None
|
properties
|
この Web サービスを提供するキー値プロパティのディクショナリ。 これらのプロパティはデプロイ後に変更できませんが、新しいキーと値のペアを追加できます。 規定値: None
|
description
|
この Web サービスを指定する説明。 規定値: None
|
___location
|
この Web サービスのデプロイ先となる Azure リージョン。 指定されていない場合、ワークスペースの場所が使用されます。 利用可能なリージョンの詳細については、「リージョン 別の製品」を参照してください。 規定値: None
|
auth_enabled
|
この Web サービスの認証を有効にするかどうかを指定します。 既定値は False です。 規定値: None
|
ssl_enabled
|
この Web サービスに対して SSL を有効にするかどうか。 既定値は False です。 規定値: None
|
enable_app_insights
|
この Web サービスに対して AppInsights を有効にするかどうか。 既定値は False です。 規定値: None
|
ssl_cert_pem_file
|
SSL が有効になっている場合に必要な証明書ファイル。 規定値: None
|
ssl_key_pem_file
|
SSL が有効になっている場合に必要なキー ファイル。 規定値: None
|
ssl_cname
|
SSL が有効になっている場合の cname。 規定値: None
|
dns_name_label
|
スコアリング エンドポイントの DNS 名ラベル。 指定しない場合は、スコアリング エンドポイントに対して一意の DNS 名ラベルが生成されます。 規定値: None
|
primary_key
|
この Web サービスに使用するプライマリ認証キー。 規定値: None
|
secondary_key
|
この Web サービスに使用するセカンダリ認証キー。 規定値: None
|
collect_model_data
|
Web サービスのモデル データ収集を有効にするかどうか。 規定値: None
|
cmk_vault_base_url
|
カスタマー マネージド キー コンテナーのベース URL 規定値: None
|
cmk_key_name
|
カスタマー マネージド キー名。 規定値: None
|
cmk_key_version
|
カスタマー マネージド キーのバージョン。 規定値: None
|
vnet_name
|
仮想ネットワーク名。 規定値: None
|
subnet_name
|
仮想ネットワーク内のサブネット名。 規定値: None
|
戻り値
型 | 説明 |
---|---|
Web サービス オブジェクトをデプロイするときに使用する構成オブジェクト。 |
例外
型 | 説明 |
---|---|
get_token
remove_tags
run
指定された入力でこの Web サービスを呼び出します。
run(input_data)
パラメーター
名前 | 説明 |
---|---|
input_data
必須
|
<xref:varies>
Web サービスを呼び出す入力。 |
戻り値
型 | 説明 |
---|---|
Web サービスを呼び出した結果。 |
例外
型 | 説明 |
---|---|
serialize
update
指定されたプロパティを使用して Web サービスを更新します。
[なし] のままにした値は、この Web サービスでは変更されません。
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
|
Web サービスにデプロイする新しいイメージ。 規定値: None
|
tags
|
この Web サービスを提供するキー値タグのディクショナリ。 既存のタグを置き換えます。 規定値: None
|
properties
|
既存のプロパティ ディクショナリに追加するキー値プロパティのディクショナリ。 規定値: None
|
description
|
この Web サービスを指定する説明。 規定値: None
|
auth_enabled
|
この Web サービスの認証を有効または無効にします。 規定値: None
|
ssl_enabled
|
この Web サービスに対して SSL を有効にするかどうか。 規定値: None
|
ssl_cert_pem_file
|
SSL が有効になっている場合に必要な証明書ファイル。 規定値: None
|
ssl_key_pem_file
|
SSL が有効になっている場合に必要なキー ファイル。 規定値: None
|
ssl_cname
|
SSL が有効になっている場合の cname。 規定値: None
|
enable_app_insights
|
この Web サービスに対して AppInsights を有効にするかどうか。 規定値: None
|
models
|
更新されたサービスにパッケージ化する Model オブジェクトの一覧。 規定値: None
|
inference_config
|
必要なモデル デプロイ プロパティを提供するために使用される InferenceConfig オブジェクト。 規定値: None
|
戻り値
型 | 説明 |
---|---|