LocalWebservice 클래스
로컬 웹 서비스 엔드포인트로 배포된 기계 학습 모델을 나타냅니다.
웹 서비스를 로컬로 배포하는 것은 시나리오를 디버깅하고 테스트하는 데 유용합니다.
로컬 웹 서비스 생성자입니다.
LocalWebservice 생성자는 제공된 작업 영역과 연결된 LocalWebservice 개체의 로컬 표현을 검색하는 데 사용됩니다.
- 상속
-
LocalWebservice
생성자
LocalWebservice(*args, **kwargs)
매개 변수
Name | Description |
---|---|
workspace
필수
|
검색할 Model 개체를 포함하는 작업 영역 개체입니다. |
name
필수
|
검색할 Webservice 개체의 이름입니다. |
must_exist
필수
|
메모리 내 개체를 만들 때 Webservice가 이미 있어야 하는지 여부를 나타냅니다. |
workspace
필수
|
검색할 Model 개체를 포함하는 작업 영역 개체입니다. |
name
필수
|
검색할 LocalWebservice 개체의 이름입니다. |
must_exist
필수
|
메모리 내 개체를 만들 때 Webservice가 이미 있어야 하는지 여부를 나타냅니다. |
설명
다음 코드 샘플에서는 로컬 Docker 웹 서비스를 만드는 방법을 보여 줍니다. 자세한 내용은 Notebook 링크를 참조하세요.
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 개체로 변환합니다. 참고 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)
매개 변수
Name | Description |
---|---|
delete_cache
필수
|
서비스에 대해 캐시된 임시 파일을 삭제할지 여부를 나타냅니다. (기본값: True) |
delete_image
필수
|
서비스의 Docker 이미지를 삭제할지 여부를 나타냅니다. (기본값: False) |
delete_volume
필수
|
서비스의 Docker 볼륨을 삭제할지 여부를 나타냅니다. (기본값: True) |
예외
형식 | Description |
---|---|
deploy_configuration
로컬 Webservice 배포를 위한 구성 개체를 만듭니다.
static deploy_configuration(port=None)
매개 변수
Name | Description |
---|---|
port
|
서비스의 HTTP 엔드포인트를 노출할 로컬 포트입니다. Default value: None
|
반환
형식 | Description |
---|---|
Webservice 개체를 배포할 때 사용할 구성 개체입니다. |
예외
형식 | Description |
---|---|
deploy_to_cloud
LocalWebservice의 구성에 따라 Webservice를 배포합니다.
deploy_to_cloud(name=None, deployment_config=None, deployment_target=None)
매개 변수
Name | Description |
---|---|
name
|
배포된 서비스에 제공할 이름입니다. 작업 영역에서 고유해야 합니다. Default value: None
|
deployment_config
|
Webservice를 구성하는 데 사용되는 WebserviceDeploymentConfiguration입니다. 이 개체가 제공되지 않으면 원하는 대상에 따라 빈 구성 개체가 사용됩니다. Default value: None
|
deployment_target
|
Webservice를 배포할 ComputeTarget입니다. ACI에 연결된 ComputeTarget이 없는 경우 이 매개 변수를 None으로 두어 ACI에 배포합니다. Default value: None
|
반환
형식 | Description |
---|---|
배포된 Webservice에 해당하는 Webservice 개체입니다. |
예외
형식 | Description |
---|---|
deserialize
모델 관리 서비스 응답 JSON 개체를 Webservice 개체로 변환합니다.
참고
LocalWebservice에 대해 지원되지 않습니다.
deserialize(workspace, webservice_payload)
매개 변수
Name | Description |
---|---|
cls
필수
|
|
workspace
필수
|
Webservice가 이 작업 영역 개체 아래에 등록되었습니다. |
webservice_payload
필수
|
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)
매개 변수
Name | Description |
---|---|
num_lines
필수
|
검색할 최대 로그 줄 수입니다. (기본값: 5000) |
raw
필수
|
서식을 지정하지 않고 원시 Docker 컨테이너 출력을 반환합니다. (기본값: False) |
반환
형식 | Description |
---|---|
이 LocalWebservice에 대한 로그입니다. |
예외
형식 | Description |
---|---|
get_token
Webservice의 인증 토큰을 검색합니다. 범위는 현재 사용자입니다.
참고
LocalWebservice에 대해 지원되지 않습니다.
get_token()
반환
형식 | Description |
---|---|
이 Webservice의 인증 토큰 및 이후에 새로 고쳐야 하는 시기입니다. |
예외
형식 | Description |
---|---|
azureml.exceptions.NotImplementedError
|
list
해당 작업 영역과 연결된 LocalWebservices를 나열합니다.
반환된 결과는 매개 변수를 사용하여 필터링할 수 있습니다.
static list(workspace, model_name=None, model_id=None, all=None)
매개 변수
Name | Description |
---|---|
workspace
필수
|
LocalWebservices와 연결된 Workspace 개체입니다. |
model_name
|
특정 모델 이름으로 배포된 LocalWebservices만 포함하도록 목록을 필터링합니다. Default value: None
|
model_id
|
특정 모델 ID로 배포된 LocalWebservices만 포함하도록 목록을 필터링합니다. Default value: None
|
all
|
모든 서비스를 표시합니다. 기본적으로 실행 중인 서비스만 표시됩니다. Default value: None
|
반환
형식 | Description |
---|---|
제공된 작업 영역과 연결된 LocalWebservices의 필터링된 목록입니다. |
예외
형식 | Description |
---|---|
regen_key
Webservice의 키 중 하나를 다시 생성합니다.
참고
LocalWebservice에 대해 지원되지 않습니다.
regen_key(key)
매개 변수
Name | Description |
---|---|
key
필수
|
다시 생성할 키입니다. 옵션은 'Primary' 또는 'Secondary'입니다. |
예외
형식 | Description |
---|---|
reload
LocalWebservice의 실행 스크립트 및 종속성을 다시 로드합니다.
그러면 실행 스크립트 및 로컬 종속성을 포함하여 업데이트된 자산의 복사본으로 서비스의 컨테이너가 다시 시작되지만 기본 이미지를 다시 빌드하지는 않습니다. 따라서 Conda/pip 종속성 또는 사용자 지정 Docker 단계의 변경 내용은 다시 로드된 LocalWebservice에 반영되지 않습니다. 이러한 변경 내용을 처리하려면 대신 update 메서드를 호출합니다.
reload(wait=False)
매개 변수
Name | Description |
---|---|
wait
필수
|
서비스의 컨테이너가 정상 상태가 될 때까지 기다립니다. (기본값: False) |
예외
형식 | Description |
---|---|
run
제공된 입력을 사용하여 이 LocalWebservice를 호출합니다.
run(input_data)
매개 변수
Name | Description |
---|---|
input_data
필수
|
<xref:varies>
LocalWebservice를 호출할 입력입니다. |
반환
형식 | Description |
---|---|
<xref:varies>
|
LocalWebservice를 호출한 결과입니다. |
예외
형식 | Description |
---|---|
serialize
이 Webservice 개체를 JSON 직렬화 사전으로 변환합니다.
serialize()
반환
형식 | Description |
---|---|
Webservice 개체의 직렬화된 표현입니다. |
예외
형식 | Description |
---|---|
update
제공된 속성으로 LocalWebservice를 업데이트합니다.
None으로 남아 있는 값은 이 LocalWebservice에서 변경되지 않고 유지됩니다.
update(models=None, image_config=None, deployment_config=None, wait=False, inference_config=None)
매개 변수
Name | Description |
---|---|
models
필수
|
LocalWebservice에 포함된 새 모델 목록입니다. |
image_config
필수
|
LocalWebservice에 적용할 이미지 구성 옵션입니다. |
deployment_config
필수
|
LocalWebservice에 적용할 배포 구성 옵션입니다. |
inference_config
필수
|
필요한 모델 배포 속성을 제공하는 데 사용되는 InferenceConfig 개체입니다. |
wait
필수
|
서비스의 컨테이너가 정상 상태가 될 때까지 기다립니다. (기본값: False) |
반환
형식 | Description |
---|---|
예외
형식 | Description |
---|---|
update_deployment_state
메모리 내 개체의 현재 상태를 새로 고칩니다.
해당 로컬 Docker 컨테이너의 현재 상태에 따라 개체 속성을 전체 업데이트합니다.
update_deployment_state(must_exist=False)
매개 변수
Name | Description |
---|---|
must_exist
|
메모리 내 개체를 만들 때 Webservice가 이미 있어야 하는지 여부를 나타냅니다. Default value: False
|
예외
형식 | Description |
---|---|
wait_for_deployment
실행 중인 LocalWebservice 배포를 폴링합니다.
wait_for_deployment(show_output=False)
매개 변수
Name | Description |
---|---|
show_output
필수
|
더 자세한 출력을 인쇄하기 위한 옵션입니다. (기본값: False) |
예외
형식 | Description |
---|---|
특성
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'