次の方法で共有

AksWebservice クラス

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

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

AksWebservice は、1 つのサービスを 1 つのエンドポイントにデプロイします。 複数のサービスを 1 つのエンドポイントにデプロイするには、 AksEndpoint クラスを使用します。

詳細については、「 Azure Kubernetes Service クラスターへのモデルのデプロイ」を参照してください。

Web サービス インスタンスを初期化します。

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

コンストラクター

AksWebservice(workspace, name)

パラメーター

名前 説明
workspace
必須
Workspace

取得する Web サービス オブジェクトを含むワークスペース オブジェクト。
name
必須
str

取得する Web サービス オブジェクトの名前。

注釈

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


   # Set the web service configuration (using default here)
   aks_config = AksWebservice.deploy_configuration()

   # # Enable token auth and disable (key) auth on the webservice
   # aks_config = AksWebservice.deploy_configuration(token_auth_enabled=True, auth_enabled=False)

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

  • deploy ワークスペースに既に登録されているモデルの Model のメソッド。

  • deploy_from_image Webserviceのメソッド。

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

  • deploy モデルを登録してイメージを作成する Webserviceのメソッド。

Web サービスの操作については、以下を参照してください。

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

変数

名前 説明
enable_app_insights
bool

Web サービスに対して AppInsights ログが有効かどうか。
autoscaler
AutoScaler

Web サービスの Autoscaler オブジェクト。
compute_name
str

Web サービスがデプロイされる ComputeTarget の名前。
container_resource_requirements
ContainerResourceRequirements

Web サービスのコンテナー リソース要件。
liveness_probe_requirements
LivenessProbeRequirements

Web サービスのライブネス プローブの要件。
data_collection
DataCollection

Web サービスの DataCollection オブジェクト。
max_concurrent_requests_per_container
int

Web サービスのコンテナーあたりの同時要求の最大数。
max_request_wait_time
int

Web サービスの最大要求待機時間 (ミリ秒単位)。
num_replicas
int

Web サービスのレプリカの数。 各レプリカは AKS ポッドに対応します。
scoring_timeout_ms
int

Web サービスのスコアリング タイムアウト (ミリ秒単位)。
azureml.core.webservice.AksWebservice.scoring_uri
str

Web サービスのスコアリング エンドポイント
is_default
bool

Web サービスが親 AksEndpoint の既定のバージョンである場合。
traffic_percentile
int

親 AksEndpoint の Web サービスにルーティングするトラフィックの割合。
version_type
VersionType

親 AksEndpoint の Web サービスのバージョンの種類。
token_auth_enabled
bool

トークン認証が Web サービスに対して有効になっているかどうか。
environment
Environment

Web サービスの作成に使用された Environment オブジェクト。
azureml.core.webservice.AksWebservice.models
list[Model]

Web サービスにデプロイされたモデルの一覧。
deployment_status
str

Web サービスの展開状態。
namespace
str

Web サービスの AKS 名前空間。
azureml.core.webservice.AksWebservice.swagger_uri
str

Web サービスの swagger エンドポイント。

メソッド

add_properties

この Web サービスのプロパティ ディクショナリにキー値ペアを追加します。
add_tags

この Web サービスのタグ ディクショナリにキー値ペアを追加します。

WebserviceExceptionを発生させます。
deploy_configuration

AKS コンピューティング ターゲットにデプロイするための構成オブジェクトを作成します。
get_access_token

この Web サービスの認証トークンを取得します。
get_token

廃止。 代わりに get_access_token メソッドを使用してください。

この Web サービスの認証トークンを取得します。
remove_tags

この Web サービスのタグディクショナリから、指定したキーを削除します。
run

指定された入力でこの Web サービスを呼び出します。
serialize

この Web サービスを JSON シリアル化ディクショナリに変換します。
update

指定されたプロパティを使用して Web サービスを更新します。

[なし] のままにした値は、この Web サービスでは変更されません。

add_properties

この Web サービスのプロパティ ディクショナリにキー値ペアを追加します。

add_properties(properties)

パラメーター

名前 説明
properties
必須
dict[str, str]

追加するプロパティのディクショナリ。

add_tags

この Web サービスのタグ ディクショナリにキー値ペアを追加します。

WebserviceExceptionを発生させます。

add_tags(tags)

パラメーター

名前 説明
tags
必須
dict[str, str]

追加するタグのディクショナリ。

例外

型 説明
WebserviceException

deploy_configuration

AKS コンピューティング ターゲットにデプロイするための構成オブジェクトを作成します。

static deploy_configuration(autoscale_enabled=None, autoscale_min_replicas=None, autoscale_max_replicas=None, autoscale_refresh_seconds=None, autoscale_target_utilization=None, collect_model_data=None, auth_enabled=None, cpu_cores=None, memory_gb=None, enable_app_insights=None, scoring_timeout_ms=None, replica_max_concurrent_requests=None, max_request_wait_time=None, num_replicas=None, primary_key=None, secondary_key=None, tags=None, properties=None, description=None, gpu_cores=None, period_seconds=None, initial_delay_seconds=None, timeout_seconds=None, success_threshold=None, failure_threshold=None, namespace=None, token_auth_enabled=None, compute_target_name=None, cpu_cores_limit=None, memory_gb_limit=None, blobfuse_enabled=None)

パラメーター

名前 説明
autoscale_enabled
bool

この Web サービスの自動スケールを有効にするかどうかを指定します。 num_replicasが None の場合、既定値は True になります。

規定値: None
autoscale_min_replicas
int

この Web サービスを自動スケールするときに使用するコンテナーの最小数。 既定値は 1 です。

規定値: None
autoscale_max_replicas
int

この Web サービスを自動スケールするときに使用するコンテナーの最大数。 既定値は 10 です。

規定値: None
autoscale_refresh_seconds
int

自動スケーラーがこの Web サービスのスケーリングを試みる頻度。 既定値は 1 です。

規定値: None
autoscale_target_utilization
int

自動スケーラーがこの Web サービスの維持を試みる必要があるターゲット使用率 (100% からパーセント)。 既定値は 70 です。

規定値: None
collect_model_data
bool

この Web サービスのモデル データ収集を有効にするかどうかを指定します。 既定値は False です。

規定値: None
auth_enabled
bool

この Web サービスのキー認証を有効にするかどうかを指定します。 既定値は True です。

規定値: None
cpu_cores
float

この Web サービスに割り当てる CPU コアの数。 10 進数を指定できます。 既定値は 0.1 です。 Azure Kubernetes Service の制限ではなく、ポッド コア要求に対応します。

規定値: None
memory_gb
float

この Web サービスに割り当てるメモリの量 (GB 単位)。 10 進数を指定できます。 既定値は 0.5 です。 Azure Kubernetes Service の制限ではなく、ポッド メモリ要求に対応します。

規定値: None
enable_app_insights
bool

この Web サービスの Application Insights ログを有効にするかどうかを指定します。 既定値は False です。

規定値: None
scoring_timeout_ms
int

この Web サービスへの呼び出しのスコア付けに適用するタイムアウト。 既定値は 60000 です。

規定値: None
replica_max_concurrent_requests
int

この Web サービスに対して許可するレプリカあたりの同時要求の最大数。 既定値は 1 です。 Microsoft テクニカル サポートまたは Azure Machine Learning チームのメンバーから指示がない限り、この設定を既定値の 1 から変更しないでください。

規定値: None
max_request_wait_time
int

503 エラーを返す前に、要求がキューに保持される最大時間 (ミリ秒単位)。 既定値は 500 です。

規定値: None
num_replicas
int

この Web サービスに割り当てるコンテナーの数。 既定値はありません。このパラメーターが設定されていない場合、自動スケーラーは既定で有効になります。

規定値: None
primary_key
str

この Web サービスに使用するプライマリ認証キー。

規定値: None
secondary_key
str

この Web サービスに使用するセカンダリ認証キー。

規定値: None
tags
dict[str, str]

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

規定値: None
properties
dict[str, str]

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

規定値: None
description
str

この Web サービスを指定する説明。

規定値: None
gpu_cores
int

この Web サービスに割り当てる GPU コアの数。 既定値は 0 です。

規定値: None
period_seconds
int

liveness probe を実行する頻度 (秒単位)。 既定値は 10 秒です。 最小値は 1 です。

規定値: None
initial_delay_seconds
int

コンテナーが起動してからライブネス プローブが開始されるまでの秒数。 既定値は 310 です。

規定値: None
timeout_seconds
int

ライブネス プローブがタイムアウトする秒数。既定値は 2 秒です。 最小値は 1 です。

規定値: None
success_threshold
int

失敗した後に成功したと見なされるライブネス プローブの最小連続成功数。 既定値は 1 です。 最小値は 1 です。

規定値: None
failure_threshold
int

Pod が起動し、liveness probe が失敗したとき、Kubernetes では、failureThreshold 回数だけ試し、それからあきらめます。 既定値は 3 です。 最小値は 1 です。

規定値: None
namespace
str

この Web サービスをデプロイする Kubernetes 名前空間:最大 63 文字の小文字 ('-'z'、'0'-'9')、ハイフン ('-') 文字。 先頭と末尾の文字をハイフンにすることはできません。

規定値: None
token_auth_enabled
bool

この Web サービスのトークン認証を有効にするかどうかを指定します。 これが有効になっている場合、ユーザーは Azure Active Directory 資格情報を使用してアクセス トークンをフェッチすることで、この Web サービスにアクセスできます。 既定値は False です。

規定値: None
compute_target_name
str

デプロイ先のコンピューティング 先の名前

規定値: None
cpu_cores_limit
float

この Web サービスで使用できる CPU コアの最大数。 10 進数を指定できます。

規定値: None
memory_gb_limit
float

この Web サービスで使用できるメモリの最大量 (GB 単位)。 10 進数を指定できます。

規定値: None
blobfuse_enabled
bool

この Web サービスのモデルのダウンロードで blobfuse を有効にするかどうかを指定します。 既定値は True

規定値: None

戻り値

型 説明
AksServiceDeploymentConfiguration

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

例外

型 説明
WebserviceException

get_access_token

この Web サービスの認証トークンを取得します。

get_access_token()

戻り値

型 説明
AksServiceAccessToken

この Web サービスの認証トークンを記述するオブジェクト。

例外

型 説明
WebserviceException

get_token

廃止。 代わりに get_access_token メソッドを使用してください。

この Web サービスの認証トークンを取得します。

get_token()

戻り値

型 説明
str, datetime

この Web サービスの認証トークンと、更新するタイミング。

例外

型 説明
WebserviceException

remove_tags

この Web サービスのタグディクショナリから、指定したキーを削除します。

remove_tags(tags)

パラメーター

名前 説明
tags
必須
list[str]

削除するキーの一覧

run

指定された入力でこの Web サービスを呼び出します。

run(input_data)

パラメーター

名前 説明
input_data
必須
<xref:varies>

Web サービスを呼び出す入力

戻り値

型 説明
dict

Web サービスを呼び出した結果

例外

型 説明
WebserviceException

serialize

この Web サービスを JSON シリアル化ディクショナリに変換します。

serialize()

戻り値

型 説明
dict

この Web サービスの JSON 表記。

update

指定されたプロパティを使用して Web サービスを更新します。

[なし] のままにした値は、この Web サービスでは変更されません。

update(image=None, autoscale_enabled=None, autoscale_min_replicas=None, autoscale_max_replicas=None, autoscale_refresh_seconds=None, autoscale_target_utilization=None, collect_model_data=None, auth_enabled=None, cpu_cores=None, memory_gb=None, enable_app_insights=None, scoring_timeout_ms=None, replica_max_concurrent_requests=None, max_request_wait_time=None, num_replicas=None, tags=None, properties=None, description=None, models=None, inference_config=None, gpu_cores=None, period_seconds=None, initial_delay_seconds=None, timeout_seconds=None, success_threshold=None, failure_threshold=None, namespace=None, token_auth_enabled=None, cpu_cores_limit=None, memory_gb_limit=None, **kwargs)

パラメーター

名前 説明
image
Image

Web サービスにデプロイする新しいイメージ

規定値: None
autoscale_enabled
bool

この Web サービスの自動スケールを有効または無効にする

規定値: None
autoscale_min_replicas
int

この Web サービスを自動スケールするときに使用するコンテナーの最小数

規定値: None
autoscale_max_replicas
int

この Web サービスを自動スケールするときに使用するコンテナーの最大数

規定値: None
autoscale_refresh_seconds
int

自動スケーラーがこの Web サービスのスケーリングを試みる頻度

規定値: None
autoscale_target_utilization
int

自動スケーラーがこの Web サービスに対して維持を試みる必要があるターゲット使用率 (100%)

規定値: None
collect_model_data
bool

この Web サービスのモデル データ収集を有効または無効にする

規定値: None
auth_enabled
bool

この Web サービスの認証を有効にするかどうか

規定値: None
cpu_cores
float

この Web サービスに割り当てる CPU コアの数。 10 進数を指定できます。

規定値: None
memory_gb
float

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

規定値: None
enable_app_insights
bool

この Web サービスに対して Application Insights ログを有効にするかどうかを指定します。

規定値: None
scoring_timeout_ms
int

この Web サービスへの呼び出しのスコア付けに適用するタイムアウト

規定値: None
replica_max_concurrent_requests
int

この Web サービスに対して許可するレプリカあたりの同時要求の最大数。

規定値: None
max_request_wait_time
int

503 エラーを返す前に、要求がキューに保持される最大時間 (ミリ秒単位)

規定値: None
num_replicas
int

この Web サービスに割り当てるコンテナーの数

規定値: None
tags
dict[str, str]

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

規定値: None
properties
dict[str, str]

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

規定値: None
description
str

この Web サービスを指定する説明

規定値: None
models
list[Model]

更新されたサービスでパッケージ化する Model オブジェクトの一覧

規定値: None
inference_config
InferenceConfig

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

規定値: None
gpu_cores
int

この Web サービスに割り当てる GPU コアの数

規定値: None
period_seconds
int

liveness probe を実行する頻度 (秒単位)。 既定値は 10 秒です。 最小値は 1 です。

規定値: None
initial_delay_seconds
int

コンテナーが起動してから、liveness プローブが開始されるまでの秒数。

規定値: None
timeout_seconds
int

ライブネス プローブがタイムアウトする秒数。既定値は 1 秒です。 最小値は 1 です。

規定値: None
success_threshold
int

失敗後、liveness probe が成功と見なされるための最小連続成功数。 既定値は 1 です。 最小値は 1 です。

規定値: None
failure_threshold
int

Pod が起動し、liveness probe が失敗したとき、Kubernetes では、failureThreshold 回数だけ試し、それからあきらめます。 既定値は 3 です。 最小値は 1 です。

規定値: None
namespace
str

この Web サービスをデプロイする Kubernetes 名前空間:最大 63 文字の小文字 ('-'z'、'0'-'9')、ハイフン ('-') 文字。 先頭と末尾の文字をハイフンにすることはできません。

規定値: None
token_auth_enabled
bool

この Web サービスのトークン認証を有効にするかどうかを指定します。 これが有効になっている場合、ユーザーは Azure Active Directory 資格情報を使用してアクセス トークンをフェッチすることで、この Web サービスにアクセスできます。 既定値は False です

規定値: None
cpu_cores_limit
float

この Web サービスで使用できる CPU コアの最大数。 10 進数を指定できます。

規定値: None
memory_gb_limit
float

この Web サービスで使用できるメモリの最大量 (GB 単位)。 10 進数を指定できます。

規定値: None
kwargs
必須
<xref:varies>

には、AKS Web サービスの Kubernetes オンライン エンドポイントとデプロイへの移行をサポートするパラメーターが含まれています。 is_migration=True|False、compute_target= です。

例外

型 説明
WebserviceException