LocalWebservice クラス

  • リファレンス

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

Web サービスをローカルにデプロイすることは、シナリオのデバッグとテストに役立ちます。

ローカル Web サービス コンストラクター。

LocalWebservice コンストラクターは、指定されたワークスペースに関連付けられている LocalWebservice オブジェクトのローカル表現を取得するために使用されます。

継承
Webservice
LocalWebservice

コンストラクター

LocalWebservice(*args, **kwargs)

パラメーター

名前 説明
workspace
必須
Workspace

取得されるモデル オブジェクトが格納されているワークスペース オブジェクト。
name
必須
str

取得する Webservice オブジェクトの名前。
must_exist
必須
bool

メモリ内オブジェクトの作成時に Webservice が既に存在する必要があるかどうか。
workspace
必須
Workspace

取得されるモデル オブジェクトが格納されているワークスペース オブジェクト。
name
必須
str

取得する LocalWebservice オブジェクトの名前。
must_exist
必須
bool

メモリ内オブジェクトの作成時に Webservice が既に存在する必要があるかどうか。

注釈

次のコード サンプルは、ローカル 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()

完全なサンプルは、https://github.com/Azure/MachineLearningNotebooks/blob/master/how-to-use-azureml/deployment/deploy-to-local/register-model-deploy-local.ipynb から入手できます

メソッド

delete

この LocalWebservice をローカル コンピューターから削除します。

この関数呼び出しは非同期ではありません。サービスが削除されるまで実行されます。
deploy_configuration

ローカル Webservice をデプロイするための構成オブジェクトを作成します。
deploy_to_cloud

LocalWebservice の構成に基づいて Webservice をデプロイします。
deserialize

モデル管理サービス応答の JSON オブジェクトを Webservice オブジェクトに変換します。

Note

LocalWebservice ではサポートされていません。
get_keys

この Webservice の認証キーを取得します。

Note

LocalWebservice ではサポートされていません。
get_logs

この LocalWebservice のログを取得します。
get_token

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

Note

LocalWebservice ではサポートされていません。
list

対応するワークスペースに関連付けられている LocalWebservices を一覧表示します。

返された結果は、パラメーターを使用してフィルター処理できます。
regen_key

Webservice のキーの 1 つを再生成します。

Note

LocalWebservice ではサポートされていません。
reload

LocalWebservice の実行スクリプトと依存関係を再読み込みします。

これにより、実行スクリプトとローカルの依存関係を含む、更新された資産のコピーでサービスのコンテナーが再起動されますが、基になるイメージは再構築されません。 したがって、Conda/pip の依存関係またはカスタム Docker の手順を変更しても、再読み込みされた LocalWebservice には反映されません。 これらの変更を処理するには、代わりに update メソッドを呼び出します。
run

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

この Webservice オブジェクトを JSON のシリアル化された辞書に変換します。
update

指定されたプロパティで LocalWebservice を更新します。

None のままの値は、この LocalWebservice では変更されません。
update_deployment_state

メモリ内オブジェクトの現在の状態を更新します。

対応するローカル Docker コンテナーの現在の状態に基づいて、オブジェクトのプロパティのインプレース更新を実行します。
wait_for_deployment

実行中の LocalWebservice デプロイをポーリングします。

delete

この LocalWebservice をローカル コンピューターから削除します。

この関数呼び出しは非同期ではありません。サービスが削除されるまで実行されます。

delete(delete_cache=True, delete_image=False, delete_volume=True)

パラメーター

名前 説明
delete_cache
必須
bool

サービス用にキャッシュされた一時ファイルを削除するかどうか。 (既定値 : True)
delete_image
必須
bool

サービスの Docker イメージを削除するかどうか。 (既定値:false)
delete_volume
必須
bool

サービスの Docker ボリュームを削除するかどうか。 (既定値 : True)

例外

型 説明
WebserviceException

deploy_configuration

ローカル Webservice をデプロイするための構成オブジェクトを作成します。

static deploy_configuration(port=None)

パラメーター

名前 説明
port
int

サービスの HTTP エンドポイントを公開するローカル ポート。

規定値: None

戻り値

型 説明
LocalWebserviceDeploymentConfiguration

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

例外

型 説明
WebserviceException

deploy_to_cloud

LocalWebservice の構成に基づいて Webservice をデプロイします。

deploy_to_cloud(name=None, deployment_config=None, deployment_target=None)

パラメーター

名前 説明
name
str

デプロイされたサービスに付ける名前。 ワークスペースで一意である必要があります。

規定値: None
deployment_config
WebserviceDeploymentConfiguration

Webservice を構成するために使用される WebserviceDeploymentConfiguration。 指定されていない場合は、目的のターゲットに基づいて空の構成オブジェクトが使用されます。

規定値: None
deployment_target
ComputeTarget

Webservice をデプロイする ComputeTarget。 ACI には関連付けられた ComputeTarget がないため、このパラメーターを None のままにして ACI にデプロイします。

規定値: None

戻り値

型 説明
Webservice

デプロイされた Webservice に対応する Webservice オブジェクト。

例外

型 説明
WebserviceException

deserialize

モデル管理サービス応答の JSON オブジェクトを Webservice オブジェクトに変換します。

Note

LocalWebservice ではサポートされていません。

deserialize(workspace, webservice_payload)

パラメーター

名前 説明
cls
必須
workspace
必須
Workspace

Webservice が登録されているワークスペース オブジェクト。
webservice_payload
必須
dict

Webservice オブジェクトに変換する JSON オブジェクト。

例外

型 説明
azureml.exceptions.NotImplementedError

get_keys

この Webservice の認証キーを取得します。

Note

LocalWebservice ではサポートされていません。

get_keys()

戻り値

型 説明

この Webservice の認証キー。

例外

型 説明
azureml.exceptions.NotImplementedError

get_logs

この LocalWebservice のログを取得します。

get_logs(num_lines=5000, raw=False)

パラメーター

名前 説明
num_lines
必須
int

取得するログ行の最大数。 (既定値: 5000)
raw
必須
bool

フォーマットを試行せずに、未加工の Docker コンテナーの出力を返します。 (既定値:false)

戻り値

型 説明
str

この LocalWebservice のログ。

例外

型 説明
WebserviceException

get_token

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

Note

LocalWebservice ではサポートされていません。

get_token()

戻り値

型 説明
str, datetime

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

例外

型 説明
azureml.exceptions.NotImplementedError

list

対応するワークスペースに関連付けられている LocalWebservices を一覧表示します。

返された結果は、パラメーターを使用してフィルター処理できます。

static list(workspace, model_name=None, model_id=None, all=None)

パラメーター

名前 説明
workspace
必須
Workspace

LocalWebservices と関連付けられている Workspace オブジェクト。
model_name
str

特定のモデル名でデプロイされた LocalWebservice のみを含めるようにリストをフィルター処理します。

規定値: None
model_id
str

特定のモデル ID でデプロイされた LocalWebservice のみを含めるようにリストをフィルター処理します。

規定値: None
all
bool

すべてのサービスを表示します。 既定では、実行中のサービスのみが表示されます。

規定値: None

戻り値

型 説明
list[LocalWebservice]

指定されたワークスペースに関連付けられている LocalWebservices のフィルター処理された一覧。

例外

型 説明
WebserviceException

regen_key

Webservice のキーの 1 つを再生成します。

Note

LocalWebservice ではサポートされていません。

regen_key(key)

パラメーター

名前 説明
key
必須
str

再生成するキー。 オプションは 'Primary' または 'Secondary' です

例外

型 説明
NotImplementedError

reload

LocalWebservice の実行スクリプトと依存関係を再読み込みします。

これにより、実行スクリプトとローカルの依存関係を含む、更新された資産のコピーでサービスのコンテナーが再起動されますが、基になるイメージは再構築されません。 したがって、Conda/pip の依存関係またはカスタム Docker の手順を変更しても、再読み込みされた LocalWebservice には反映されません。 これらの変更を処理するには、代わりに update メソッドを呼び出します。

reload(wait=False)

パラメーター

名前 説明
wait
必須
bool

サービスのコンテナーが正常な状態になるまで待ちます。 (既定値:false)

例外

型 説明
WebserviceException

run

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

run(input_data)

パラメーター

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

LocalWebservice を呼び出すときに使用する入力。

戻り値

型 説明
<xref:varies>

LocalWebservice を呼び出した結果。

例外

型 説明
WebserviceException

serialize

この Webservice オブジェクトを JSON のシリアル化された辞書に変換します。

serialize()

戻り値

型 説明
dict

Webservice オブジェクトのシリアル化された表現。

例外

型 説明
WebserviceException

update

指定されたプロパティで LocalWebservice を更新します。

None のままの値は、この LocalWebservice では変更されません。

update(models=None, image_config=None, deployment_config=None, wait=False, inference_config=None)

パラメーター

名前 説明
models
必須
list[Model]

LocalWebservice に含まれるモデルの新しい一覧。
image_config
必須
ContainerImageConfig

LocalWebservice に適用するイメージ構成オプション。
deployment_config
必須
LocalWebserviceDeploymentConfiguration

LocalWebservice に適用するデプロイ構成オプション。
inference_config
必須
InferenceConfig

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

サービスのコンテナーが正常な状態になるまで待ちます。 (既定値:false)

戻り値

型 説明
None

例外

型 説明
WebserviceException

update_deployment_state

メモリ内オブジェクトの現在の状態を更新します。

対応するローカル Docker コンテナーの現在の状態に基づいて、オブジェクトのプロパティのインプレース更新を実行します。

update_deployment_state(must_exist=False)

パラメーター

名前 説明
must_exist
bool

メモリ内オブジェクトの作成時に Webservice が既に存在する必要があるかどうか。

規定値: False

例外

型 説明
WebserviceException

wait_for_deployment

実行中の LocalWebservice デプロイをポーリングします。

wait_for_deployment(show_output=False)

パラメーター

名前 説明
show_output
必須
bool

さらに詳細な出力を印刷するためのオプション。 (既定値:false)

例外

型 説明
WebserviceException

属性

port

ローカル Webservice ポートを取得します。

戻り値

型 説明
int

ポート番号。

scoring_uri

ローカルの Webservice スコアリング URI を取得します。

戻り値

型 説明
str

スコアリング URI。

swagger_uri

ローカル Webservice Swagger URI を取得します。

戻り値

型 説明
str

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'