共用方式為

LocalWebservice 類別

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

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

本機 Web 服務建構函式。

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

建構函式

LocalWebservice(*args, **kwargs)

參數

名稱 Description
workspace
必要
Workspace

包含要擷取之任何 Model 物件的工作區物件。
name
必要
str

要擷取的Webservice物件名稱。
must_exist
必要
bool

建立記憶體內部物件時，Web 服務是否必須已經存在。
workspace
必要
Workspace

包含要擷取之任何 Model 物件的工作區物件。
name
必要
str

要擷取的LocalWebservice物件名稱。
must_exist
必要
bool

建立記憶體內部物件時，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

建立組態物件以部署本機 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)

參數

名稱 Description
delete_cache
必要
bool

是否要刪除針對服務快取的暫存盤。 （預設值：True）
delete_image
必要
bool

是否要刪除服務的 Docker 映像。 (預設值：False)
delete_volume
必要
bool

是否要刪除服務的 Docker 磁碟區。 （預設值：True）

例外狀況

類型 Description
WebserviceException

deploy_configuration

建立組態物件以部署本機 Webservice。

static deploy_configuration(port=None)

參數

名稱 Description
port
int

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

預設值: None

傳回

類型 Description
LocalWebserviceDeploymentConfiguration

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

例外狀況

類型 Description
WebserviceException

deploy_to_cloud

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

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

參數

名稱 Description
name
str

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

預設值: None
deployment_config
WebserviceDeploymentConfiguration

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

預設值: None
deployment_target
ComputeTarget

ComputeTarget要在其中部署 Webservice 的 。 由於 ACI 沒有相關聯的 ComputeTarget，請將此參數保留為 None 以部署至 ACI。

預設值: None

傳回

類型 Description
Webservice

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

例外狀況

類型 Description
WebserviceException

deserialize

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

備註

LocalWebservice 不支援。

deserialize(workspace, webservice_payload)

參數

名稱 Description
cls
必要
workspace
必要
Workspace

Webservice 所登錄的工作區物件。
webservice_payload
必要
dict

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

例外狀況

類型 Description
azureml.exceptions.NotImplementedError

get_keys

擷取此 Webservice 的驗證金鑰。

備註

LocalWebservice 不支援。

get_keys()

傳回

類型 Description

此 Webservice 的驗證金鑰。

例外狀況

類型 Description
azureml.exceptions.NotImplementedError

get_logs

擷取此 LocalWebservice 的記錄。

get_logs(num_lines=5000, raw=False)

參數

名稱 Description
num_lines
必要
int

要擷取的記錄行數目上限。 （預設值：5000）
raw
必要
bool

傳回未經處理的 Docker 容器輸出，而不嘗試將它格式化。 (預設值：False)

傳回

類型 Description
str

此 LocalWebservice 的記錄。

例外狀況

類型 Description
WebserviceException

get_token

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

備註

LocalWebservice 不支援。

get_token()

傳回

類型 Description
str, datetime

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

例外狀況

類型 Description
azureml.exceptions.NotImplementedError

list

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

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

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

參數

名稱 Description
workspace
必要
Workspace

與 LocalWebservices 相關聯的 Workspace 物件。
model_name
str

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

預設值: None
model_id
str

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

預設值: None
all
bool

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

預設值: None

傳回

類型 Description
list[LocalWebservice]

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

例外狀況

類型 Description
WebserviceException

regen_key

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

備註

LocalWebservice 不支援。

regen_key(key)

參數

名稱 Description
key
必要
str

要重新產生哪些金鑰。 選項為 'Primary' 或 'Secondary'

例外狀況

類型 Description
NotImplementedError

reload

重載 LocalWebservice 的執行腳本和相依性。

這會重新啟動服務的容器，其中包含更新的資產複本，包括執行腳本和本機相依性，但不會重建基礎映像。 因此，Conda/pip 相依性或自定義 Docker 步驟的變更將不會反映在重載的 LocalWebservice 中。 若要處理這些變更，請 update 改為呼叫 方法。

reload(wait=False)

參數

名稱 Description
wait
必要
bool

等候服務的容器達到狀況良好的狀態。 (預設值：False)

例外狀況

類型 Description
WebserviceException

run

使用提供的輸入呼叫此 LocalWebservice。

run(input_data)

參數

名稱 Description
input_data
必要
<xref:varies>

要用來呼叫 LocalWebservice 的輸入。

傳回

類型 Description
<xref:varies>

呼叫 LocalWebservice 的結果。

例外狀況

類型 Description
WebserviceException

serialize

將此 Webservice 物件轉換成 JSON 串行化字典。

serialize()

傳回

類型 Description
dict

Webservice 物件的串行化表示。

update

使用提供的屬性更新 LocalWebservice。

保留為 None 的值將會在此 LocalWebservice 中保持不變。

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

參數

名稱 Description
models
必要
list[Model]

LocalWebservice 中包含的新模型清單。
image_config
必要
ContainerImageConfig

要套用至 LocalWebservice 的映像組態選項。
deployment_config
必要
LocalWebserviceDeploymentConfiguration

要套用至 LocalWebservice 的部署組態選項。
inference_config
必要
InferenceConfig

用來提供必要模型部署屬性的 InferenceConfig 物件。
wait
必要
bool

等候服務的容器達到狀況良好的狀態。 (預設值：False)

傳回

類型 Description
None

例外狀況

類型 Description
WebserviceException

update_deployment_state

重新整理記憶體內部物件的目前狀態。

根據對應本機 Docker 容器的目前狀態，執行對象的屬性就地更新。

update_deployment_state(must_exist=False)

參數

名稱 Description
must_exist
bool

建立記憶體內部物件時，Web 服務是否必須已經存在。

預設值: False

wait_for_deployment

輪詢執行中的LocalWebservice部署。

wait_for_deployment(show_output=False)

參數

名稱 Description
show_output
必要
bool

列印更多詳細信息輸出的選項。 (預設值：False)

例外狀況

類型 Description
WebserviceException

屬性

port

取得本機 Webservice 埠。

傳回

類型 Description
int

埠號碼。

scoring_uri

取得本機 Web 服務評分 URI。

傳回

類型 Description
str

評分 URI。

swagger_uri

取得本機 Webservice Swagger URI。

傳回

類型 Description
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'