LocalWebservice クラス
ローカル Web サービス エンドポイントとしてデプロイされた機械学習モデルを表します。
Web サービスをローカルにデプロイすることは、シナリオのデバッグとテストに役立ちます。
ローカル Web サービス コンストラクター。
LocalWebservice コンストラクターは、指定されたワークスペースに関連付けられている LocalWebservice オブジェクトのローカル表現を取得するために使用されます。
コンストラクター
LocalWebservice(*args, **kwargs)パラメーター
| 名前 | 説明 |
|---|---|
|
workspace
必須
|
取得される Model オブジェクトを含むワークスペース オブジェクト。 |
|
name
必須
|
取得する Web サービス オブジェクトの名前。 |
|
must_exist
必須
|
メモリ内オブジェクトの作成時に Web サービスが既に存在している必要があるかどうか。 |
|
workspace
必須
|
取得される Model オブジェクトを含むワークスペース オブジェクト。 |
|
name
必須
|
取得する LocalWebservice オブジェクトの名前。 |
|
must_exist
必須
|
メモリ内オブジェクトの作成時に Web サービスが既に存在している必要があるかどうか。 |
注釈
次のコード サンプルは、ローカル Docker Web サービスを作成する方法を示しています。 詳細については、ノートブックのリンクを参照してください。
from azureml.core.webservice import LocalWebservice
# This is optional, if not provided Docker will choose a random unused port.
deployment_config = LocalWebservice.deploy_configuration(port=6789)
local_service = Model.deploy(ws, "test", [model], inference_config, deployment_config)
local_service.wait_for_deployment()
メソッド
| delete |
この LocalWebservice をローカル コンピューターから削除します。 この関数呼び出しは非同期ではありません。サービスが削除されるまで実行されます。 |
| deploy_configuration |
ローカル Web サービスをデプロイするための構成オブジェクトを作成します。 |
| deploy_to_cloud |
LocalWebservice の構成に基づいて Web サービスをデプロイします。 |
| deserialize |
Model Management Service 応答 JSON オブジェクトを Web サービス オブジェクトに変換します。 注 LocalWebservice ではサポートされていません。 |
| get_keys |
この Web サービスの認証キーを取得します。 注 LocalWebservice ではサポートされていません。 |
| get_logs |
この LocalWebservice のログを取得します。 |
| get_token |
現在のユーザーにスコープを設定して、この Web サービスの認証トークンを取得します。 注 LocalWebservice ではサポートされていません。 |
| list |
対応するワークスペースに関連付けられている LocalWebservice を一覧表示します。 返される結果は、パラメーターを使用してフィルター処理できます。 |
| regen_key |
Web サービスのいずれかのキーを再生成します。 注 LocalWebservice ではサポートされていません。 |
| reload |
LocalWebservice の実行スクリプトと依存関係を再読み込みします。 これにより、実行スクリプトやローカルの依存関係など、更新された資産のコピーを使用してサービスのコンテナーが再起動されますが、基になるイメージは再構築されません。 したがって、Conda/pip 依存関係またはカスタム Docker ステップへの変更は、再読み込みされた LocalWebservice には反映されません。 これらの変更を処理するには、代わりに update メソッドを呼び出します。 |
| run |
指定された入力を使用して、この LocalWebservice を呼び出します。 |
| serialize |
この Web サービス オブジェクトを JSON シリアル化ディクショナリに変換します。 |
| update |
指定されたプロパティを使用して LocalWebservice を更新します。 [なし] のままにした値は、この LocalWebservice では変更されません。 |
| update_deployment_state |
メモリ内オブジェクトの現在の状態を更新します。 対応するローカル Docker コンテナーの現在の状態に基づいて、オブジェクトのプロパティのインプレース更新を実行します。 |
| wait_for_deployment |
実行中の LocalWebservice デプロイをポーリングします。 |
delete
この LocalWebservice をローカル コンピューターから削除します。
この関数呼び出しは非同期ではありません。サービスが削除されるまで実行されます。
delete(delete_cache=True, delete_image=False, delete_volume=True)パラメーター
| 名前 | 説明 |
|---|---|
|
delete_cache
必須
|
サービス用にキャッシュされた一時ファイルを削除するかどうかを指定します。 (既定値: True) |
|
delete_image
必須
|
サービスの Docker イメージを削除するかどうか。 (既定値:false) |
|
delete_volume
必須
|
サービスの Docker ボリュームを削除するかどうか。 (既定値: True) |
例外
| 型 | 説明 |
|---|---|
deploy_configuration
ローカル Web サービスをデプロイするための構成オブジェクトを作成します。
static deploy_configuration(port=None)パラメーター
| 名前 | 説明 |
|---|---|
|
port
|
サービスの HTTP エンドポイントを公開するローカル ポート。 規定値: None
|
戻り値
| 型 | 説明 |
|---|---|
|
Web サービス オブジェクトをデプロイするときに使用する構成オブジェクト。 |
例外
| 型 | 説明 |
|---|---|
deploy_to_cloud
LocalWebservice の構成に基づいて Web サービスをデプロイします。
deploy_to_cloud(name=None, deployment_config=None, deployment_target=None)パラメーター
| 名前 | 説明 |
|---|---|
|
name
|
デプロイされたサービスに付ける名前。 ワークスペースに対して一意である必要があります。 規定値: None
|
|
deployment_config
|
Web サービスの構成に使用される WebserviceDeploymentConfiguration。 指定されていない場合は、目的のターゲットに基づいて空の構成オブジェクトが使用されます。 規定値: None
|
|
deployment_target
|
Web サービスをデプロイする ComputeTarget 。 ACI には ComputeTargetが関連付けられていないので、このパラメーターは None のままにして ACI にデプロイします。 規定値: None
|
戻り値
| 型 | 説明 |
|---|---|
|
デプロイされた Web サービスに対応する Web サービス オブジェクト。 |
例外
| 型 | 説明 |
|---|---|
deserialize
Model Management Service 応答 JSON オブジェクトを Web サービス オブジェクトに変換します。
注
LocalWebservice ではサポートされていません。
deserialize(workspace, webservice_payload)パラメーター
| 名前 | 説明 |
|---|---|
|
cls
必須
|
|
|
workspace
必須
|
Web サービスが登録されているワークスペース オブジェクト。 |
|
webservice_payload
必須
|
Web サービス オブジェクトに変換する JSON オブジェクト。 |
例外
| 型 | 説明 |
|---|---|
|
azureml.exceptions.NotImplementedError
|
get_keys
この Web サービスの認証キーを取得します。
注
LocalWebservice ではサポートされていません。
get_keys()戻り値
| 型 | 説明 |
|---|---|
|
この Web サービスの認証キー。 |
例外
| 型 | 説明 |
|---|---|
|
azureml.exceptions.NotImplementedError
|
get_logs
この LocalWebservice のログを取得します。
get_logs(num_lines=5000, raw=False)パラメーター
| 名前 | 説明 |
|---|---|
|
num_lines
必須
|
取得するログ行の最大数。 (既定値: 5000) |
|
raw
必須
|
書式設定を試みずに、生の Docker コンテナー出力を返します。 (既定値:false) |
戻り値
| 型 | 説明 |
|---|---|
|
この LocalWebservice のログ。 |
例外
| 型 | 説明 |
|---|---|
get_token
list
対応するワークスペースに関連付けられている LocalWebservice を一覧表示します。
返される結果は、パラメーターを使用してフィルター処理できます。
static list(workspace, model_name=None, model_id=None, all=None)パラメーター
| 名前 | 説明 |
|---|---|
|
workspace
必須
|
LocalWebservices に関連付けられている Workspace オブジェクト。 |
|
model_name
|
特定のモデル名でデプロイされた LocalWebservice のみを含むように一覧をフィルター処理します。 規定値: None
|
|
model_id
|
特定のモデル ID でデプロイされた LocalWebservice のみを含むように一覧をフィルター処理します。 規定値: None
|
|
all
|
すべてのサービスを表示します。 既定では、実行中のサービスのみが表示されます。 規定値: None
|
戻り値
| 型 | 説明 |
|---|---|
|
指定されたワークスペースに関連付けられている LocalWebservice のフィルター処理された一覧。 |
例外
| 型 | 説明 |
|---|---|
regen_key
Web サービスのいずれかのキーを再生成します。
注
LocalWebservice ではサポートされていません。
regen_key(key)パラメーター
| 名前 | 説明 |
|---|---|
|
key
必須
|
再生成するキー。 オプションは "プライマリ" または "セカンダリ" です |
例外
| 型 | 説明 |
|---|---|
reload
LocalWebservice の実行スクリプトと依存関係を再読み込みします。
これにより、実行スクリプトやローカルの依存関係など、更新された資産のコピーを使用してサービスのコンテナーが再起動されますが、基になるイメージは再構築されません。 したがって、Conda/pip 依存関係またはカスタム Docker ステップへの変更は、再読み込みされた LocalWebservice には反映されません。 これらの変更を処理するには、代わりに update メソッドを呼び出します。
reload(wait=False)パラメーター
| 名前 | 説明 |
|---|---|
|
wait
必須
|
サービスのコンテナーが正常な状態になるまで待ちます。 (既定値:false) |
例外
| 型 | 説明 |
|---|---|
run
指定された入力を使用して、この LocalWebservice を呼び出します。
run(input_data)パラメーター
| 名前 | 説明 |
|---|---|
|
input_data
必須
|
<xref:varies>
LocalWebservice を呼び出す入力。 |
戻り値
| 型 | 説明 |
|---|---|
|
<xref:varies>
|
LocalWebservice を呼び出した結果。 |
例外
| 型 | 説明 |
|---|---|
serialize
update
指定されたプロパティを使用して LocalWebservice を更新します。
[なし] のままにした値は、この LocalWebservice では変更されません。
update(models=None, image_config=None, deployment_config=None, wait=False, inference_config=None)パラメーター
| 名前 | 説明 |
|---|---|
|
models
必須
|
LocalWebservice に含まれるモデルの新しい一覧。 |
|
image_config
必須
|
LocalWebservice に適用するイメージ構成オプション。 |
|
deployment_config
必須
|
LocalWebservice に適用するデプロイ構成オプション。 |
|
inference_config
必須
|
必要なモデル デプロイ プロパティを提供するために使用される InferenceConfig オブジェクト。 |
|
wait
必須
|
サービスのコンテナーが正常な状態になるまで待ちます。 (既定値:false) |
戻り値
| 型 | 説明 |
|---|---|
例外
| 型 | 説明 |
|---|---|
update_deployment_state
メモリ内オブジェクトの現在の状態を更新します。
対応するローカル Docker コンテナーの現在の状態に基づいて、オブジェクトのプロパティのインプレース更新を実行します。
update_deployment_state(must_exist=False)パラメーター
| 名前 | 説明 |
|---|---|
|
must_exist
|
メモリ内オブジェクトの作成時に Web サービスが既に存在している必要があるかどうか。 規定値: False
|
wait_for_deployment
実行中の LocalWebservice デプロイをポーリングします。
wait_for_deployment(show_output=False)パラメーター
| 名前 | 説明 |
|---|---|
|
show_output
必須
|
より詳細な出力を出力するオプション。 (既定値:false) |
例外
| 型 | 説明 |
|---|---|
属性
port
scoring_uri
swagger_uri
NETWORK_NAME
NETWORK_NAME = 'azureml-local'STATE_DELETED
STATE_DELETED = 'deleted'STATE_DEPLOYING
STATE_DEPLOYING = 'deploying'STATE_FAILED
STATE_FAILED = 'failed'STATE_RUNNING
STATE_RUNNING = 'running'STATE_UNKNOWN
STATE_UNKNOWN = 'unknown'