LocalWebservice 類別

參考

表示部署為本機 Web 服務端點的機器學習模型。

在本機部署 Web 服務對於偵錯和測試案例很有用。

本機 Webservice 建構函式。

LocalWebservice 建構函式是用來擷取與所提供工作區相關聯的 LocalWebservice 物件的本機標記法。

繼承: Webservice

LocalWebservice

建構函式

LocalWebservice(*args, **kwargs)

參數

workspace: Workspace

必要

包含將擷取之任何 Model 物件的工作區物件。

name: str

必要

要擷取的 Webservice 物件名稱。

must_exist: bool

必要

建立記憶體內建物件時，Webservice 是否必須已經存在。

workspace: Workspace

必要

包含將擷取之任何 Model 物件的工作區物件。

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 的組態部署 Web 服務。
deserialize	將模型管理服務回應 JSON 物件轉換成 Webservice 物件。注意 LocalWebservice 不支援。
get_keys	擷取此 Webservice 的驗證金鑰。注意 LocalWebservice 不支援。
get_logs	擷取此 LocalWebservice 的記錄。
get_token	擷取此 Webservice 的驗證權杖，範圍限定為目前使用者。注意 LocalWebservice 不支援。
list	列出與對應工作區相關聯的 LocalWebservices。傳回的結果可以使用參數進行篩選。
regen_key	重新產生其中一個 Webservice 的金鑰。注意 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

預設值: None

本機連接埠上公開服務的 HTTP 端點。

傳回

部署 Webservice 物件時要使用的組態物件。

傳回類型

LocalWebserviceDeploymentConfiguration

例外狀況

WebserviceException

deploy_to_cloud

根據 LocalWebservice 的組態部署 Web 服務。

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

參數

name: str

預設值: None

要提供已部署服務的名稱。工作區必須是唯一的。

deployment_config: WebserviceDeploymentConfiguration

預設值: None

用來設定 Web 服務的 WebserviceDeploymentConfiguration。如果未提供，則會根據所需的目標使用空的組態物件。

deployment_target: ComputeTarget

預設值: None

要 ComputeTarget 部署 Webservice 的。因為 ACI 沒有相關聯的 ComputeTarget ，請將此參數保留為 None 以部署到 ACI。

傳回

對應至已部署 Webservice 的 Webservice 物件。

傳回類型

Webservice

例外狀況

WebserviceException

deserialize

將模型管理服務回應 JSON 物件轉換成 Webservice 物件。

注意

LocalWebservice 不支援。

deserialize(workspace, webservice_payload)

參數

cls

必要

workspace: Workspace

必要

Webservice 所登錄的工作區物件。

webservice_payload: dict

必要

要轉換成 Webservice 物件的 JSON 物件。

例外狀況

azureml.exceptions.NotImplementedError

get_keys

擷取此 Webservice 的驗證金鑰。

注意

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

例外狀況

WebserviceException

get_token

擷取此 Webservice 的驗證權杖，範圍限定為目前使用者。

注意

LocalWebservice 不支援。

get_token()

傳回

此 Webservice 的驗證權杖，以及何時應該重新整理。

傳回類型

str, datetime

例外狀況

azureml.exceptions.NotImplementedError

list

列出與對應工作區相關聯的 LocalWebservices。

傳回的結果可以使用參數進行篩選。

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

參數

workspace: Workspace

必要

與 LocalWebservices 相關聯的 Workspace 物件。

model_name: str

預設值: None

篩選清單，只包含以特定模型名稱部署的 LocalWebservices。

model_id: str

預設值: None

篩選清單，只包含以特定模型識別碼部署的 LocalWebservices。

all: bool

預設值: None

顯示所有服務。預設只會顯示執行中的服務。

傳回

與所提供工作區相關聯的 LocalWebservices 篩選清單。

傳回類型

list[LocalWebservice]

例外狀況

WebserviceException

regen_key

重新產生其中一個 Webservice 的金鑰。

注意

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 的輸入。

傳回

呼叫 LocalWebservice 的結果。

傳回類型

<xref:varies>

例外狀況

WebserviceException

serialize

將此 Webservice 物件轉換成 JSON 序列化的字典。

serialize()

傳回

Webservice 物件的序列化表示。

傳回類型

dict

例外狀況

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

預設值: False

建立記憶體內建物件時，Webservice 是否必須已經存在。

例外狀況

WebserviceException

wait_for_deployment

輪詢執行中的 LocalWebservice 部署。

wait_for_deployment(show_output=False)

參數

show_output: bool

必要

列印更多詳細資訊輸出的選項。 (預設：False)

例外狀況

WebserviceException

屬性

port

取得本機 Webservice 埠。

傳回

連接埠號碼。

傳回類型

int

scoring_uri

取得本機 Web 服務評分 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'

LocalWebservice 類別

建構函式

參數

備註

方法

delete

參數

例外狀況

deploy_configuration

參數

傳回

傳回類型

例外狀況

deploy_to_cloud

參數

傳回

傳回類型

例外狀況

deserialize

參數

例外狀況

get_keys

傳回

例外狀況

get_logs

參數

傳回

傳回類型

例外狀況

get_token

傳回

傳回類型

例外狀況

list

參數

傳回

傳回類型

例外狀況

regen_key

參數

例外狀況

reload

參數

例外狀況

run

參數

傳回

傳回類型

例外狀況

serialize

傳回

傳回類型

例外狀況

update

參數

傳回類型

例外狀況

update_deployment_state

參數

例外狀況

wait_for_deployment

參數

例外狀況

屬性

port

傳回

傳回類型

scoring_uri

傳回

傳回類型

swagger_uri

傳回

傳回類型

NETWORK_NAME

STATE_DELETED

STATE_DEPLOYING

STATE_FAILED

STATE_RUNNING

STATE_UNKNOWN

意見反應