LocalWebservice クラス

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

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

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

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

継承
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)

例外

deploy_configuration

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

static deploy_configuration(port=None)

パラメーター

port
int
既定値: None

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

戻り値

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

の戻り値の型 :

例外

deploy_to_cloud

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

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

パラメーター

name
str
既定値: None

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

deployment_config
WebserviceDeploymentConfiguration
既定値: None

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

deployment_target
ComputeTarget
既定値: None

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

戻り値

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

の戻り値の型 :

例外

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)

戻り値

この LocalWebservice のログ。

の戻り値の型 :

str

例外

get_token

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

Note

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

get_token()

戻り値

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

の戻り値の型 :

例外

azureml.exceptions.NotImplementedError

list

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

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

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

パラメーター

workspace
Workspace
必須

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

model_name
str
既定値: None

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

model_id
str
既定値: None

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

all
bool
既定値: None

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

戻り値

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

の戻り値の型 :

例外

regen_key

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

Note

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

regen_key(key)

パラメーター

key
str
必須

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

例外

reload

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

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

reload(wait=False)

パラメーター

wait
bool
必須

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

例外

run

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

run(input_data)

パラメーター

input_data
<xref:varies>
必須

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

戻り値

LocalWebservice を呼び出した結果。

の戻り値の型 :

<xref:varies>

例外

serialize

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

serialize()

戻り値

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

の戻り値の型 :

例外

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)

の戻り値の型 :

例外

update_deployment_state

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

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

update_deployment_state(must_exist=False)

パラメーター

must_exist
bool
既定値: False

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

例外

wait_for_deployment

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

wait_for_deployment(show_output=False)

パラメーター

show_output
bool
必須

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

例外

属性

port

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

戻り値

ポート番号。

の戻り値の型 :

int

scoring_uri

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

戻り値

スコアリング URI。

の戻り値の型 :

str

swagger_uri

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

戻り値

Swagger URI。

の戻り値の型 :

str

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'