AksEndpoint クラス

注

これは試験的なクラスであり、いつでも変更される可能性があります。 詳細については、https://aka.ms/azuremlexperimental を参照してください。

Azure Kubernetes Service で実行されている同じエンドポイントの背後にある Web サービス バージョンのコレクションを表します。

AksWebserviceは単一のスコアリング エンドポイントを持つ 1 つのサービスをデプロイしますが、AksEndpoint クラスを使用すると、同じスコアリング エンドポイントの背後に複数の Web サービス バージョンをデプロイできます。 A/B テストなど、制御された方法でモデルをデプロイできるように、トラフィックの割合を提供するように各 Web サービス バージョンを構成できます。 AksEndpoint を使用すると、AksWebservice と同様のモデル オブジェクトからデプロイできます。

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

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

コンストラクター

AksEndpoint(workspace, name)

パラメーター

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

変数

名前	説明
versions	dict[str, AksWebservice] バージョン名からバージョン オブジェクトへのディクショナリ。 このエンドポイントの一部としてデプロイされたすべてのバージョンが含まれます。

メソッド

create_version	指定されたプロパティを使用してエンドポイントに新しいバージョンを追加します。
delete_version	エンドポイント内のバージョンを削除します。
deploy_configuration	AKS コンピューティング ターゲットにデプロイするための構成オブジェクトを作成します。
serialize	この Web サービスを JSON シリアル化ディクショナリに変換します。
update	指定されたプロパティを使用してエンドポイントを更新します。 [なし] のままにした値は、このエンドポイントで変更されません
update_version	指定されたプロパティを使用して、エンドポイント内の既存のバージョンを更新します。 [なし] のままにした値は、このバージョンでは変更されません。

create_version

指定されたプロパティを使用してエンドポイントに新しいバージョンを追加します。

create_version(version_name, autoscale_enabled=None, autoscale_min_replicas=None, autoscale_max_replicas=None, autoscale_refresh_seconds=None, autoscale_target_utilization=None, collect_model_data=None, cpu_cores=None, memory_gb=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, traffic_percentile=None, is_default=None, is_control_version_type=None, cpu_cores_limit=None, memory_gb_limit=None)

パラメーター

名前	説明
version_name 必須	str エンドポイントに追加するバージョンの名前。
autoscale_enabled	bool エンドポイントでこのバージョンの自動スケールを有効にするかどうか。 num_replicasが None の場合、既定値は True です。 規定値: None
autoscale_min_replicas	int エンドポイントでこのバージョンを自動スケールするときに使用するコンテナーの最小数。 既定値は 1 規定値: None
autoscale_max_replicas	int エンドポイントでこのバージョンを自動スケールするときに使用するコンテナーの最大数。 既定値は 10 規定値: None
autoscale_refresh_seconds	int 自動スケーラーがエンドポイントでこのバージョンのスケーリングを試みる頻度。 既定値は 1 規定値: None
autoscale_target_utilization	int 自動スケーラーがエンドポイントでこのバージョンの維持を試行する必要があるターゲット使用率 (100% のうち割合)。 既定値は 70 規定値: None
collect_model_data	bool エンドポイントでこのバージョンのモデル データ収集を有効にするかどうか。 既定値は False です 規定値: None
cpu_cores	float エンドポイントでこのバージョンに割り当てる CPU コアの数。 10 進数を指定できます。 既定値は 0.1 規定値: None
memory_gb	float エンドポイントでこのバージョンに割り当てるメモリの量 (GB 単位)。 10 進数を指定できます。 既定値は 0.5 規定値: None
scoring_timeout_ms	int エンドポイントでこのバージョンへの呼び出しをスコアリングするために適用するタイムアウト。 既定値は 60000 です。 規定値: None
replica_max_concurrent_requests	int エンドポイントでこのバージョンを許可するレプリカあたりの同時要求の最大数。 既定値は 1 です。 Microsoft テクニカル サポートまたは Azure Machine Learning チームのメンバーから指示がない限り、この設定を既定値の 1 から変更しないでください。 規定値: None
max_request_wait_time	int 503 エラーを返す前に、要求がキューに保持される最大時間 (ミリ秒単位)。 既定値は 500 です。 規定値: None
num_replicas	int エンドポイントでこのバージョンに割り当てるコンテナーの数。 既定値はありません。このパラメーターが設定されていない場合、自動スケーラーは既定で有効になります。 規定値: None
tags	dict[str, str] このエンドポイントを提供するキー値タグのディクショナリ。 規定値: None
properties	dict[str, str] このエンドポイントを提供するキー値プロパティのディクショナリ。 これらのプロパティはデプロイ後に変更できませんが、新しいキーと値のペアを追加できます。 規定値: None
description	str このエンドポイントを指定する説明。 規定値: None
models	list[Model] 更新されたサービスでパッケージ化する Model オブジェクトの一覧。 規定値: None
inference_config	InferenceConfig 必要なモデル デプロイ プロパティを提供するために使用される InferenceConfig オブジェクト。 規定値: None
gpu_cores	int エンドポイントでこのバージョンに割り当てる 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
traffic_percentile	float バージョンがエンドポイントで受け取るトラフィックの量。 規定値: None
is_default	bool エンドポイントでこのバージョンを既定のバージョンにするかどうか。 既定値は False です。 規定値: None
is_control_version_type	bool エンドポイントでこのバージョンをコントロール バージョンとして作成するかどうか。 既定値は False です。 規定値: None
cpu_cores_limit	float この Web サービスで使用できる CPU コアの最大数。 10 進数を指定できます。 規定値: None
memory_gb_limit	float この Web サービスで使用できるメモリの最大量 (GB 単位)。 10 進数を指定できます。 規定値: None

例外

型	説明
WebserviceException

delete_version

エンドポイント内のバージョンを削除します。

delete_version(version_name)

パラメーター

名前	説明
version_name 必須	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, version_name=None, traffic_percentile=None, compute_target_name=None, cpu_cores_limit=None, memory_gb_limit=None)

パラメーター

名前	説明
autoscale_enabled	bool エンドポイントでこのバージョンの自動スケールを有効にするかどうか。 num_replicasが None の場合、既定値は True です。 規定値: None
autoscale_min_replicas	int エンドポイントでこのバージョンを自動スケールするときに使用するコンテナーの最小数。 既定値は 1 です。 規定値: None
autoscale_max_replicas	int エンドポイントでこのバージョンを自動スケールするときに使用するコンテナーの最大数。 既定値は 10 です。 規定値: None
autoscale_refresh_seconds	int 自動スケーラーがエンドポイントでこのバージョンのスケーリングを試みる頻度。 既定値は 1 です。 規定値: None
autoscale_target_utilization	int 自動スケーラーがエンドポイントでこのバージョンの維持を試行する必要があるターゲット使用率 (100% のうち割合)。 既定値は 70 です。 規定値: None
collect_model_data	bool エンドポイントでこのバージョンのモデル データ収集を有効にするかどうか。 既定値は False です。 規定値: None
auth_enabled	bool エンドポイントでこのバージョンのキー認証を有効にするかどうか。 既定値は True です。 規定値: None
cpu_cores	float エンドポイントでこのバージョンに割り当てる CPU コアの数。 10 進数を指定できます。 既定値は 0.1 規定値: None
memory_gb	float エンドポイントでこのバージョンに割り当てるメモリの量 (GB 単位)。 10 進数を指定できます。 既定値は 0.5 規定値: None
enable_app_insights	bool エンドポイントでこのバージョンの ApplicationInsights ログを有効にするかどうか。 既定値は False です。 規定値: None
scoring_timeout_ms	int エンドポイントでこのバージョンにスコアリング呼び出しを適用するためのタイムアウト。 既定値は 60000 規定値: None
replica_max_concurrent_requests	int エンドポイントでこのバージョンを許可するレプリカあたりの同時要求の最大数。 既定値は 1 です。 Microsoft テクニカル サポートまたは Azure Machine Learning チームのメンバーから指示がない限り、この設定を既定値の 1 から変更しないでください。 規定値: None
max_request_wait_time	int 503 エラーを返す前に、要求がキューに保持される最大時間 (ミリ秒単位)。 既定値は 500 です。 規定値: None
num_replicas	int エンドポイントでこのバージョンに割り当てるコンテナーの数。 既定値はありません。このパラメーターが設定されていない場合、自動スケーラーは既定で有効になります。 規定値: None
primary_key	str このエンドポイントに使用するプライマリ認証キー。 規定値: None
secondary_key	str このエンドポイントに使用するセカンダリ認証キー。 規定値: None
tags	dict[str, str] このエンドポイントを提供するキー値タグのディクショナリ。 規定値: None
properties	dict[str, str] このエンドポイントを提供するキー値プロパティのディクショナリ。 これらのプロパティはデプロイ後に変更できませんが、新しいキーと値のペアを追加できます 規定値: None
description	str このエンドポイントを指定する説明。 規定値: None
gpu_cores	int エンドポイントでこのバージョンに割り当てる GPU コアの数。 既定値は 0 です。 規定値: None
period_seconds	int liveness probe を実行する頻度 (秒単位)。 既定値は 10 秒です。 最小値は 1 です。 規定値: None
initial_delay_seconds	int コンテナーが起動してから、liveness プローブが開始されるまでの秒数。 既定値は 310 です。 規定値: None
timeout_seconds	int ライブネス プローブがタイムアウトする秒数。既定値は 2 秒です。 最小値は 1 です。 規定値: None
success_threshold	int 失敗後、liveness probe が成功と見なされるための最小連続成功数。 既定値は 1 です。 最小値は 1 です。 規定値: None
failure_threshold	int ポッドが起動し、ライブネス プローブが失敗すると、Kubernetes は failureThreshold 時間試行してから、あきらめていきます。 既定値は 3 です。 最小値は 1 です。 規定値: None
namespace	str このエンドポイントをデプロイする Kubernetes 名前空間:最大 63 文字の小文字の英数字 ('a-'z'、'0'-'9')、ハイフン ('-') 文字。 先頭と末尾の文字をハイフンにすることはできません。 規定値: None
token_auth_enabled	bool このエンドポイントのトークン認証を有効にするかどうかを指定します。 これが有効になっている場合、ユーザーは Azure Active Directory 資格情報を使用してアクセス トークンをフェッチすることで、このエンドポイントにアクセスできます。 既定値は False です。 規定値: None
version_name	str エンドポイント内のバージョンの名前。 規定値: None
traffic_percentile	float バージョンがエンドポイントで受け取るトラフィックの量。 規定値: None
compute_target_name	str デプロイ先のコンピューティング 先の名前 規定値: None
cpu_cores_limit	float この Web サービスで使用できる CPU コアの最大数。 10 進数を指定できます。 規定値: None
memory_gb_limit	float この Web サービスで使用できるメモリの最大量 (GB 単位)。 10 進数を指定できます。 規定値: None

戻り値

型	説明
AksEndpointDeploymentConfiguration

例外

型	説明
WebserviceException

serialize

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

serialize()

戻り値

型	説明
dict	この Web サービスの JSON 表記。

update

指定されたプロパティを使用してエンドポイントを更新します。

[なし] のままにした値は、このエンドポイントで変更されません

update(auth_enabled=None, token_auth_enabled=None, enable_app_insights=None, description=None, tags=None, properties=None)

パラメーター

名前	説明
auth_enabled	bool エンドポイントでこのバージョンのキー認証を有効にするかどうか。 既定値は True です。 規定値: None
token_auth_enabled	bool このエンドポイントのトークン認証を有効にするかどうかを指定します。 これが有効になっている場合、ユーザーは Azure Active Directory 資格情報を使用してアクセス トークンをフェッチすることで、このエンドポイントにアクセスできます。 既定値は False です。 規定値: None
enable_app_insights	bool エンドポイントでこのバージョンの Application Insights ログを有効にするかどうか。 既定値は False です。 規定値: None
description	str このエンドポイントを指定する説明。 規定値: None
tags	dict[str, str] このエンドポイントを提供するキー値タグのディクショナリ。 規定値: None
properties	dict[str, str] このエンドポイントを提供するキー値プロパティのディクショナリ。 これらのプロパティはデプロイ後に変更できませんが、新しいキーと値のペアを追加できます。 規定値: None

例外

型	説明
WebserviceException

update_version

指定されたプロパティを使用して、エンドポイント内の既存のバージョンを更新します。

[なし] のままにした値は、このバージョンでは変更されません。

update_version(version_name, autoscale_enabled=None, autoscale_min_replicas=None, autoscale_max_replicas=None, autoscale_refresh_seconds=None, autoscale_target_utilization=None, collect_model_data=None, cpu_cores=None, memory_gb=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, traffic_percentile=None, is_default=None, is_control_version_type=None, cpu_cores_limit=None, memory_gb_limit=None)

パラメーター

名前	説明
version_name 必須	str エンドポイント内のバージョンの名前。
autoscale_enabled	bool エンドポイントでこのバージョンの自動スケールを有効にするかどうか。 num_replicasが None の場合、既定値は True になります。 規定値: None
autoscale_min_replicas	int エンドポイントでこのバージョンを自動スケールするときに使用するコンテナーの最小数。 既定値は 1 です。 規定値: None
autoscale_max_replicas	int エンドポイントでこのバージョンを自動スケールするときに使用するコンテナーの最大数。 既定値は 10 です。 規定値: None
autoscale_refresh_seconds	int 自動スケーラーがエンドポイントでこのバージョンのスケーリングを試みる頻度。 既定値は 1 規定値: None
autoscale_target_utilization	int 自動スケーラーがエンドポイントでこのバージョンの維持を試行する必要があるターゲット使用率 (100% のうち割合)。 既定値は 70 です。 規定値: None
collect_model_data	bool エンドポイントでこのバージョンのモデル データ収集を有効にするかどうか。 既定値は False です。 規定値: None
cpu_cores	float エンドポイントでこのバージョンに割り当てる CPU コアの数。 10 進数を指定できます。 既定値は 0.1 規定値: None
memory_gb	float エンドポイントでこのバージョンに割り当てるメモリの量 (GB 単位)。 10 進数を指定できます。 既定値は 0.5 規定値: None
scoring_timeout_ms	int エンドポイントでこのバージョンへの呼び出しをスコアリングするために適用するタイムアウト。 既定値は 60000 です。 規定値: None
replica_max_concurrent_requests	int エンドポイントでこのバージョンを許可するレプリカあたりの同時要求の最大数。 既定値は 1 です。 Microsoft テクニカル サポートまたは Azure Machine Learning チームのメンバーから指示がない限り、この設定を既定値の 1 から変更しないでください。 規定値: None
max_request_wait_time	int 503 エラーを返す前に、要求がキューに保持される最大時間 (ミリ秒単位)。 既定値は 500 です。 規定値: None
num_replicas	int エンドポイントでこのバージョンに割り当てるコンテナーの数。 既定値はありません。このパラメーターが設定されていない場合、自動スケーラーは既定で有効になります。 規定値: None
tags	dict[str, str] このエンドポイントを提供するキー値タグのディクショナリ。 規定値: None
properties	dict[str, str] このエンドポイントを提供するキー値プロパティのディクショナリ。 これらのプロパティはデプロイ後に変更できませんが、新しいキーと値のペアを追加できます。 規定値: None
description	str このエンドポイントを指定する説明 規定値: None
models	list[Model] 更新されたサービスでパッケージ化する Model オブジェクトの一覧 規定値: None
inference_config	InferenceConfig 必要なモデル デプロイ プロパティを提供するために使用される InferenceConfig オブジェクト。 規定値: None
gpu_cores	int エンドポイントでこのバージョンに割り当てる 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
traffic_percentile	float バージョンがエンドポイントで受け取るトラフィックの量。 規定値: None
is_default	bool エンドポイントでこのバージョンを既定のバージョンにするかどうか。 既定値は False です。 規定値: None
is_control_version_type	bool エンドポイントでこのバージョンをコントロール バージョンとして作成するかどうか。 既定値は False です。 規定値: None
cpu_cores_limit	float この Web サービスで使用できる CPU コアの最大数。 10 進数を指定できます。 規定値: None
memory_gb_limit	float この Web サービスで使用できるメモリの最大量 (GB 単位)。 10 進数を指定できます。 規定値: None

例外

型	説明
WebserviceException