次の方法で共有


AksEndpoint クラス

Note

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

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

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

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

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

継承
AksEndpoint

コンストラクター

AksEndpoint(workspace, name)

パラメーター

workspace
Workspace
必須

取得する Webservice オブジェクトを含むワークスペース オブジェクト。

name
str
必須

取得する Webservice オブジェクトの名前。

変数

versions
dict[str, AksWebservice]

バージョン名からバージョン オブジェクトへのディクショナリ。 このエンドポイントの一部としてデプロイされたすべてのバージョンが含まれています。

メソッド

create_version

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

delete_version

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

deploy_configuration

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

serialize

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

update

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

None のままの値は、このエンドポイントでは変更されません。

update_version

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

None のままの値は、このバージョンでは変更されません。

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
既定値: None

エンドポイントでこのバージョンの自動スケーリングを有効にするかどうか。 num_replicas が None の場合、既定値は True です。

autoscale_min_replicas
int
既定値: None

エンドポイントでこのバージョンを自動スケーリングするときに使用するコンテナーの最小数。 既定値は 1 です。

autoscale_max_replicas
int
既定値: None

エンドポイントでこのバージョンを自動スケーリングするときに使用するコンテナーの最大数。 既定値は 10 です

autoscale_refresh_seconds
int
既定値: None

自動スケーラーがエンドポイントでこのバージョンのスケーリングを試行する頻度。 既定値は 1 です。

autoscale_target_utilization
int
既定値: None

自動スケーラーがエンドポイントでこのバージョンに対して維持しようとする目標使用率 (最大 100%)。 既定値は 70 です。

collect_model_data
bool
既定値: None

エンドポイントでこのバージョンに対してモデル データ コレクションを有効にするかどうか。 既定値は False です

cpu_cores
float
既定値: None

エンドポイントでこのバージョンに割り当てる CPU コアの数。 10 進数を指定できます。 既定値は 0.1 です

memory_gb
float
既定値: None

エンドポイントでこのバージョンに割り当てるメモリの量 (GB 単位)。 10 進数を指定できます。 既定値は 0.5 です

scoring_timeout_ms
int
既定値: None

エンドポイントでこのバージョンへのスコアリング呼び出しに適用されるタイムアウト。 既定値は 60000 です。

replica_max_concurrent_requests
int
既定値: None

エンドポイントでこのバージョンに許可するレプリカあたりの最大同時要求数。 既定値は 1 です。 この設定は、マイクロソフト テクニカル サポートまたはマイクロソフトの Azure Machine Learning チームのメンバーの指示がない限り、既定値の 1 してください。

max_request_wait_time
int
既定値: None

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

num_replicas
int
既定値: None

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

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

このエンドポイントに提供するキー値タグのディクショナリ。

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

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

description
str
既定値: None

このエンドポイントに関する説明。

models
list[Model]
既定値: None

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

inference_config
InferenceConfig
既定値: None

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

gpu_cores
int
既定値: None

エンドポイントでこのバージョンに割り当てる GPU コアの数。 既定値は 0 です。

period_seconds
int
既定値: None

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

initial_delay_seconds
int
既定値: None

コンテナーの起動後、liveness probe が開始するまでの秒数。 既定値は 310 です。

timeout_seconds
int
既定値: None

liveness probe がタイムアウトするまでの秒数。既定値は 2 秒です。 最大値は 1 です。

success_threshold
int
既定値: None

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

failure_threshold
int
既定値: None

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

traffic_percentile
float
既定値: None

エンドポイントでこのバージョンが受け取るトラフィックの量。

is_default
bool
既定値: None

エンドポイントでこのバージョンを既定のバージョンにするかどうか。 既定値は False です。

is_control_version_type
bool
既定値: None

エンドポイントでこのバージョンをコントロール バージョンにするかどうか。 既定値は False です。

cpu_cores_limit
float
既定値: None

この Webservice で使用できる CPU コアの最大数。 10 進数を指定できます。

memory_gb_limit
float
既定値: None

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

例外

delete_version

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

delete_version(version_name)

パラメーター

version_name
str
必須

削除するエンドポイント内のバージョンの名前。

例外

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
既定値: None

エンドポイントでこのバージョンの自動スケーリングを有効にするかどうか。 num_replicas が None の場合、既定値は True です。

autoscale_min_replicas
int
既定値: None

エンドポイントでこのバージョンを自動スケーリングするときに使用するコンテナーの最小数。 既定値は 1 です。

autoscale_max_replicas
int
既定値: None

エンドポイントでこのバージョンを自動スケーリングするときに使用するコンテナーの最大数。 既定値は 10 です。

autoscale_refresh_seconds
int
既定値: None

自動スケーラーがエンドポイントでこのバージョンのスケーリングを試行する頻度。 既定値は 1 です。

autoscale_target_utilization
int
既定値: None

自動スケーラーがエンドポイントでこのバージョンに対して維持しようとする目標使用率 (最大 100%)。 既定値は 70 です。

collect_model_data
bool
既定値: None

エンドポイントでこのバージョンに対してモデル データ コレクションを有効にするかどうか。 既定値は False です。

auth_enabled
bool
既定値: None

エンドポイントでこのバージョンのキー認証を有効にするかどうか。 既定値は True です。

cpu_cores
float
既定値: None

エンドポイントでこのバージョンに割り当てる CPU コアの数。 10 進数を指定できます。 既定値は 0.1 です

memory_gb
float
既定値: None

エンドポイントでこのバージョンに割り当てるメモリの量 (GB 単位)。 10 進数を指定できます。 既定値は 0.5 です

enable_app_insights
bool
既定値: None

エンドポイントでこのバージョンの ApplicationInsights ログを有効にするかどうか。 既定値は False です。

scoring_timeout_ms
int
既定値: None

エンドポイントでこのバージョンへのスコアリング呼び出しに適用されるタイムアウト。 既定値は 60000 です。

replica_max_concurrent_requests
int
既定値: None

エンドポイントでこのバージョンに許可するレプリカあたりの最大同時要求数。 既定値は 1 です。 この設定は、マイクロソフト テクニカル サポートまたはマイクロソフトの Azure Machine Learning チームのメンバーの指示がない限り、既定値の 1 してください。

max_request_wait_time
int
既定値: None

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

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
既定値: None

エンドポイントでこのバージョンに割り当てる GPU コアの数。 既定値は 0 です。

period_seconds
int
既定値: None

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

initial_delay_seconds
int
既定値: None

コンテナーの起動後、liveness probe が開始するまでの秒数。 既定値は 310 です。

timeout_seconds
int
既定値: None

liveness probe がタイムアウトするまでの秒数。既定値は 2 秒です。 最大値は 1 です。

success_threshold
int
既定値: None

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

failure_threshold
int
既定値: None

Pod が起動し、liveness probe が失敗した場合、Kubernetes は failureThreshold 回試してから、あきらめます。 既定値は 3 です。 最大値は 1 です。

namespace
str
既定値: None

このエンドポイントをデプロイする Kubernetes 名前空間: 最大 63 文字の小文字の英数字 ('a'-'z'、'0'-'9') とハイフン ('-') 文字。 先頭と末尾の文字をハイフンにすることはできません。

token_auth_enabled
bool
既定値: None

このエンドポイントに対してトークン認証を有効にするかどうか。 これが有効になっている場合、ユーザーは Azure Active Directory の資格情報を使用してアクセス トークンを取得することにより、このエンドポイントにアクセスできます。 既定値は False です。

version_name
str
既定値: None

エンドポイント内のバージョンの名前。

traffic_percentile
float
既定値: None

エンドポイントでこのバージョンが受け取るトラフィックの量。

compute_target_name
str
既定値: None

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

cpu_cores_limit
float
既定値: None

この Webservice で使用できる CPU コアの最大数。 10 進数を指定できます。

memory_gb_limit
float
既定値: None

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

の戻り値の型 :

例外

serialize

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

serialize()

戻り値

この Webservice の JSON 表現。

の戻り値の型 :

例外

update

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

None のままの値は、このエンドポイントでは変更されません。

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

パラメーター

auth_enabled
bool
既定値: None

エンドポイントでこのバージョンのキー認証を有効にするかどうか。 既定値は True です。

token_auth_enabled
bool
既定値: None

このエンドポイントに対してトークン認証を有効にするかどうか。 これが有効になっている場合、ユーザーは Azure Active Directory の資格情報を使用してアクセス トークンを取得することにより、このエンドポイントにアクセスできます。 既定値は False です。

enable_app_insights
bool
既定値: None

エンドポイントでこのバージョンの Application Insights ログを有効にするかどうか。 既定値は False です。

description
str
既定値: None

このエンドポイントに関する説明。

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

このエンドポイントに提供するキー値タグのディクショナリ。

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

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

例外

update_version

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

None のままの値は、このバージョンでは変更されません。

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
既定値: None

エンドポイントでこのバージョンの自動スケーリングを有効にするかどうか。 num_replicas が None の場合、既定値は True です。

autoscale_min_replicas
int
既定値: None

エンドポイントでこのバージョンを自動スケーリングするときに使用するコンテナーの最小数。 既定値は 1 です。

autoscale_max_replicas
int
既定値: None

エンドポイントでこのバージョンを自動スケーリングするときに使用するコンテナーの最大数。 既定値は 10 です。

autoscale_refresh_seconds
int
既定値: None

自動スケーラーがエンドポイントでこのバージョンのスケーリングを試行する頻度。 既定値は 1 です。

autoscale_target_utilization
int
既定値: None

自動スケーラーがエンドポイントでこのバージョンに対して維持しようとする目標使用率 (最大 100%)。 既定値は 70 です。

collect_model_data
bool
既定値: None

エンドポイントでこのバージョンに対してモデル データ コレクションを有効にするかどうか。 既定値は False です。

cpu_cores
float
既定値: None

エンドポイントでこのバージョンに割り当てる CPU コアの数。 10 進数を指定できます。 既定値は 0.1 です

memory_gb
float
既定値: None

エンドポイントでこのバージョンに割り当てるメモリの量 (GB 単位)。 10 進数を指定できます。 既定値は 0.5 です

scoring_timeout_ms
int
既定値: None

エンドポイントでこのバージョンへのスコアリング呼び出しに適用されるタイムアウト。 既定値は 60000 です。

replica_max_concurrent_requests
int
既定値: None

エンドポイントでこのバージョンに許可するレプリカあたりの最大同時要求数。 既定値は 1 です。 この設定は、マイクロソフト テクニカル サポートまたはマイクロソフトの Azure Machine Learning チームのメンバーの指示がない限り、既定値の 1 してください。

max_request_wait_time
int
既定値: None

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

num_replicas
int
既定値: None

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

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

このエンドポイントに提供するキー値タグのディクショナリ。

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

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

description
str
既定値: None

このエンドポイントに関する説明

models
list[Model]
既定値: None

更新されたサービスを使用してパッケージ化するモデル オブジェクトのリスト

inference_config
InferenceConfig
既定値: None

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

gpu_cores
int
既定値: None

エンドポイントでこのバージョンに割り当てる GPU コアの数。 既定値は 0 です。

period_seconds
int
既定値: None

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

initial_delay_seconds
int
既定値: None

コンテナーの起動後、liveness probe が開始するまでの秒数。 既定値は 310 です。

timeout_seconds
int
既定値: None

liveness probe がタイムアウトするまでの秒数。既定値は 2 秒です。 最大値は 1 です。

success_threshold
int
既定値: None

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

failure_threshold
int
既定値: None

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

traffic_percentile
float
既定値: None

エンドポイントでこのバージョンが受け取るトラフィックの量。

is_default
bool
既定値: None

エンドポイントでこのバージョンを既定のバージョンにするかどうか。 既定値は False です。

is_control_version_type
bool
既定値: None

エンドポイントでこのバージョンをコントロール バージョンにするかどうか。 既定値は False です。

cpu_cores_limit
float
既定値: None

この Webservice で使用できる CPU コアの最大数。 10 進数を指定できます。

memory_gb_limit
float
既定値: None

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

例外