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

既定値: None

この Webservice に割り当てる CPU コアの数。 10 進数を指定できます。既定値は 0.1 です

memory_gb: float

既定値: None

この Web サービスに割り当てるメモリの量 (GB 単位)。 10 進数を指定できます。既定値は 0.5 です

tags: dict[str, str]

既定値: None

この Web サービスに提供するキー値タグのディクショナリ。

properties: dict[str, str]

既定値: None

この Web サービスに提供するキー値プロパティのディクショナリ。これらのプロパティはデプロイ後に変更することはできませんが、新しいキーと値のペアを追加できます。

description: str

既定値: None

この Web サービスに提供する説明。

location: str

既定値: None

この Web サービスのデプロイ先となる Azure リージョン。指定されていない場合、ワークスペースの場所が使用されます。使用可能なリージョンの詳細については、リージョン別の製品に関するページを参照してください。

auth_enabled: bool

既定値: None

この Web サービスに対して認証を有効にするかどうか。既定値は False です。

ssl_enabled: bool

既定値: None

この Web サービスに対して SSL を有効にするかどうか。既定値は False です。

enable_app_insights: bool

既定値: None

この Web サービスに対して AppInsights を有効にするかどうか。既定値は False です。

ssl_cert_pem_file: str

既定値: None

SSL が有効な場合、証明書ファイルが必要です。

ssl_key_pem_file: str

既定値: None

SSL が有効な場合、キーファイルが必要です。

ssl_cname: str

既定値: None

SSL が有効な場合の cname

dns_name_label: str

既定値: None

スコアリングエンドポイントの DNS 名ラベル。指定されていない場合、一意の DNS 名ラベルがスコアリングエンドポイントに対して生成されます。

primary_key: str

既定値: None

この Webservice に使用するプライマリ認証キー。

secondary_key: str

既定値: None

この Webservice に使用するセカンダリ認証キー。

collect_model_data: bool

既定値: None

Webservice に対してモデルデータ収集を有効にするかどうかを指定します。

cmk_vault_base_url: str

既定値: None

カスタマーマネージドキーコンテナーのベース URL

cmk_key_name: str

既定値: None

カスタマーマネージドキーの名前。

cmk_key_version: str

既定値: None

カスタマーマネージドキーのバージョン。

vnet_name: str

既定値: None

仮想ネットワークの名前。

subnet_name: str

既定値: None

仮想ネットワーク内のサブネット名。

戻り値

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

の戻り値の型 :

AciServiceDeploymentConfiguration

例外

WebserviceException

get_token

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

Note

実装されていません。

get_token()

戻り値

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

の戻り値の型 :

str, datetime

例外

azureml.exceptions.NotImplementedError

remove_tags

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

remove_tags(tags)

パラメーター

tags: list[str]

必須

削除するキーのリスト。

run

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

run(input_data)

パラメーター

input_data: <xref:varies>

必須

Webservice を呼び出す際に使用する入力。

戻り値

Webservice を呼び出した結果。

の戻り値の型 :

dict

例外

WebserviceException

serialize

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

serialize()

戻り値

この Webservice オブジェクトの JSON 表現。

の戻り値の型 :

dict

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

既定値: None

Webservice にデプロイする新しいイメージ。

tags: dict[str, str]

既定値: None

この Webservice に提供するキー値タグのディクショナリ。既存のタグを置き換えます。

properties: dict[str, str]

既定値: None

既存のプロパティディクショナリに追加するキー値プロパティのディクショナリ。

description: str

既定値: None

この Webservice に提供する説明。

auth_enabled: bool

既定値: None

この Webservice に対して認証を有効または無効にします。

ssl_enabled: bool

既定値: None

この Web サービスに対して SSL を有効にするかどうか。

ssl_cert_pem_file: str

既定値: None

SSL が有効な場合、証明書ファイルが必要です。

ssl_key_pem_file: str

既定値: None

SSL が有効な場合、キーファイルが必要です。

ssl_cname: str

既定値: None

SSL が有効な場合の cname

enable_app_insights: bool

既定値: None

この Web サービスに対して AppInsights を有効にするかどうか。

models: list[Model]

既定値: None

更新されたサービスにパッケージ化する Model オブジェクトのリスト。

inference_config: InferenceConfig

既定値: None

必要なモデルデプロイプロパティを提供するために使用される InferenceConfig オブジェクト。

の戻り値の型 :

None

AciWebservice クラス

コンストラクター

パラメーター

注釈

変数

メソッド

add_properties

パラメーター

add_tags

パラメーター

例外

deploy_configuration

パラメーター

戻り値

の戻り値の型 :

例外

get_token

戻り値

の戻り値の型 :

例外

remove_tags

パラメーター

run

パラメーター

戻り値

の戻り値の型 :

例外

serialize

戻り値

の戻り値の型 :

update

パラメーター

の戻り値の型 :

フィードバック

フィードバック

その他のリソース