다음을 통해 공유

Webservice 클래스

Azure Machine Learning에서 모델을 웹 서비스 엔드포인트로 배포하기 위한 기본 기능을 정의합니다.

웹 서비스 생성자는 제공된 작업 영역과 연결된 Webservice 개체의 클라우드 표현을 검색하는 데 사용됩니다. 검색된 Webservice 개체의 특정 형식에 해당하는 자식 클래스의 인스턴스를 반환합니다. Webservice 클래스를 사용하면 A 또는 Model 개체에서 Image 기계 학습 모델을 배포할 수 있습니다.

Webservice 작업에 대한 자세한 내용은 Azure Machine Learning을 사용하여 모델 배포를 참조하세요.

Webservice 인스턴스를 초기화합니다.

Webservice 생성자는 제공된 작업 영역과 연결된 Webservice 개체의 클라우드 표현을 검색합니다. 검색된 Webservice 개체의 특정 형식에 해당하는 자식 클래스의 인스턴스를 반환합니다.

생성자

Webservice(workspace, name)

매개 변수

Name Description
workspace
필수
Workspace

검색할 Webservice 개체를 포함하는 작업 영역 개체입니다.
name
필수
str

검색할 Webservice 개체의 이름입니다.
workspace
필수
Workspace

검색할 Webservice 개체를 포함하는 작업 영역 개체입니다.
name
필수
str

검색할 Webservice 개체의 이름입니다.

설명

다음 샘플에서는 먼저 Webservice의 자식 클래스 메서드를 사용하여 구성 개체 deploy_configuration 를 만든 다음 클래스AksWebservice의 메서드 deploy 와 함께 Model 구성을 사용하는 권장 배포 패턴을 보여 줍니다.


   # Set the web service configuration (using default here)
   aks_config = AksWebservice.deploy_configuration()

   # # Enable token auth and disable (key) auth on the webservice
   # aks_config = AksWebservice.deploy_configuration(token_auth_enabled=True, auth_enabled=False)

다음 샘플에서는 작업 영역에서 기존 AciWebservice 항목을 찾아 이름을 다시 사용할 수 있도록 작업 영역이 있는 경우 삭제하는 방법을 보여 줍니다.


   from azureml.core.model import InferenceConfig
   from azureml.core.webservice import AciWebservice


   service_name = 'my-custom-env-service'

   inference_config = InferenceConfig(entry_script='score.py', environment=environment)
   aci_config = AciWebservice.deploy_configuration(cpu_cores=1, memory_gb=1)

   service = Model.deploy(workspace=ws,
                          name=service_name,
                          models=[model],
                          inference_config=inference_config,
                          deployment_config=aci_config,
                          overwrite=True)
   service.wait_for_deployment(show_output=True)

다음을 포함하여 모델을 웹 서비스로 배포하는 방법에는 여러 가지가 있습니다.

  • deploy Model 작업 영역에 이미 등록된 모델의 메서드입니다.

  • deploy_from_image 모델에서 이미 만든 이미지의 Webservice 메서드입니다.

  • deploy_from_model Webservice 작업 영역에 이미 등록된 모델의 메서드입니다. 이 메서드는 이미지를 만듭니다.

  • deploy 모델을 등록하고 이미지를 만드는 의 Webservice메서드입니다.

웹 서비스 작업에 대한 자세한 내용은

변수 섹션에는 클라우드 Webservice 개체의 로컬 표현 특성이 나열됩니다. 이러한 변수는 읽기 전용으로 간주되어야 합니다. 해당 값 변경은 해당 클라우드 개체에 반영되지 않습니다.

변수

Name Description
auth_enabled
bool

웹 서비스에서 인증을 사용하도록 설정했는지 여부입니다.
compute_type
str

웹 서비스가 배포되는 컴퓨팅 유형입니다.
created_time
datetime

웹 서비스를 만든 경우입니다.
azureml.core.Webservice.description

Webservice 개체에 대한 설명입니다.
azureml.core.Webservice.tags

Webservice 개체에 대한 태그 사전입니다.
azureml.core.Webservice.name

웹 서비스의 이름입니다.
azureml.core.Webservice.properties

웹 서비스에 대한 키 값 속성의 사전입니다. 배포 후에는 이러한 속성을 변경할 수 없지만 새 키 값 쌍을 추가할 수 있습니다.
created_by
str

웹 서비스를 만든 사용자입니다.
error
str

웹 서비스를 배포하지 못한 경우 실패한 이유에 대한 오류 메시지가 포함됩니다.
azureml.core.Webservice.state

웹 서비스의 현재 상태입니다.
updated_time
datetime

웹 서비스가 마지막으로 업데이트된 시간입니다.
azureml.core.Webservice.workspace

이 웹 서비스를 포함하는 Azure Machine Learning 작업 영역입니다.
token_auth_enabled
bool

웹 서비스에 토큰 인증을 사용할 수 있는지 여부입니다.

메서드

check_for_existing_webservice

웹 서비스가 있는지 확인합니다.
delete

연결된 작업 영역에서 이 웹 서비스를 삭제합니다.

이 함수 호출은 비동기식이 아닙니다. 호출은 리소스가 삭제될 때까지 실행됩니다. 모델 관리 서비스에서 모델을 삭제하는 데 문제가 있는 경우 A WebserviceException 가 발생합니다.
deploy

0개 이상의 Model 개체에서 웹 서비스를 배포합니다.

이 함수는 제공된 모든 모델 파일을 등록하고 지정된 Workspace모든 모델과 연결된 이미지를 프로세스에 만듭니다. 이전에 등록되지 않은 모델을 배포할 디렉터리가 있는 경우 이 함수를 사용합니다.

결과 웹 서비스는 유추 요청에 사용할 수 있는 실시간 엔드포인트입니다. 자세한 내용은 웹 서비스로 배포된 모델 사용을 참조하세요.
deploy_from_image

개체에서 Image 웹 서비스를 배포합니다.

모델에 대해 만든 Image 개체가 이미 있는 경우 이 함수를 사용합니다.

결과 웹 서비스는 유추 요청에 사용할 수 있는 실시간 엔드포인트입니다. 자세한 내용은 웹 서비스로 배포된 모델 사용을 참조하세요.
deploy_from_model

0개 이상의 Model 개체에서 웹 서비스를 배포합니다.

이 함수는 유사 deploy하지만 모델을 등록하지는 않습니다. 이미 등록된 모델 개체가 있는 경우 이 함수를 사용합니다. 그러면 지정된 작업 영역과 연결된 프로세스가 이미지를 만듭니다.

결과 웹 서비스는 유추 요청에 사용할 수 있는 실시간 엔드포인트입니다. 자세한 내용은 웹 서비스로 배포된 모델 사용을 참조하세요.
deploy_local_from_model

테스트용으로 빌드 LocalWebservice 및 배포합니다.

Docker를 설치하고 구성해야 합니다.
deserialize

모델 관리 서비스 응답 JSON 개체를 Webservice 개체로 변환합니다.

제공된 작업 영역이 웹 서비스가 등록된 작업 영역이 아닌 경우 실패합니다.
get_keys

이 웹 서비스에 대한 인증 키를 검색합니다.
get_logs

이 웹 서비스에 대한 로그를 검색합니다.
get_token

현재 사용자로 범위가 지정된 이 웹 서비스에 대한 인증 토큰을 검색합니다.
list

해당 Workspace웹 서비스와 연결된 웹 서비스를 나열합니다.

반환된 결과는 매개 변수를 사용하여 필터링할 수 있습니다.
regen_key

웹 서비스의 키 중 하나인 '기본' 또는 '보조' 키를 다시 생성합니다.

지정하지 않았거나 'Primary' 또는 'Secondary'가 아닌 경우 WebserviceException A key 가 발생합니다.
run

제공된 입력을 사용하여 이 웹 서비스를 호출합니다.

의 Webservice자식 클래스에 의해 구현되는 추상 메서드
serialize

이 Webservice 개체를 JSON 직렬화된 사전으로 변환합니다.

Webservice 개체로 다시 변환하는 데 사용합니다 deserialize .
update

웹 서비스 매개 변수를 업데이트합니다.

이 메서드는 자식 클래스에 의해 구현되는 추상 메서드입니다 Webservice. 업데이트할 수 있는 매개 변수는 Webservice 자식 형식에 따라 달라집니다. 예를 들어 Azure Container Instances 웹 서비스의 경우 특정 매개 변수를 참조 update 하세요.
update_deployment_state

메모리 내 개체의 현재 상태를 새로 고칩니다.

해당 클라우드 개체의 현재 상태에 따라 개체의 속성을 현재 위치로 업데이트합니다. 생성 상태의 수동 폴링에 주로 유용합니다.
wait_for_deployment

실행 중인 웹 서비스 배포에 대해 자동으로 폴링합니다.

웹 서비스가 터미널 상태에 도달할 때까지 기다립니다. 성공하지 못한 터미널 상태에 도달하거나 제공된 시간 제한을 초과하는 경우 throw WebserviceException 됩니다.

check_for_existing_webservice

웹 서비스가 있는지 확인합니다.

static check_for_existing_webservice(workspace, name, overwrite=False, request_func=None, check_func=None)

매개 변수

Name Description
workspace
필수
Workspace
name
필수
str
overwrite
bool
Default value: False
request_func
<xref:function>

서비스 이름이 있는지 확인하기 위해 서비스를 요청하는 함수

Default value: None
check_func
<xref:function>

함수를 사용하여 request_func 응답 콘텐츠 확인

Default value: None

예외

형식 Description
WebserviceException

delete

연결된 작업 영역에서 이 웹 서비스를 삭제합니다.

이 함수 호출은 비동기식이 아닙니다. 호출은 리소스가 삭제될 때까지 실행됩니다. 모델 관리 서비스에서 모델을 삭제하는 데 문제가 있는 경우 A WebserviceException 가 발생합니다.

delete()

예외

형식 Description
WebserviceException

deploy

0개 이상의 Model 개체에서 웹 서비스를 배포합니다.

이 함수는 제공된 모든 모델 파일을 등록하고 지정된 Workspace모든 모델과 연결된 이미지를 프로세스에 만듭니다. 이전에 등록되지 않은 모델을 배포할 디렉터리가 있는 경우 이 함수를 사용합니다.

결과 웹 서비스는 유추 요청에 사용할 수 있는 실시간 엔드포인트입니다. 자세한 내용은 웹 서비스로 배포된 모델 사용을 참조하세요.

static deploy(workspace, name, model_paths, image_config, deployment_config=None, deployment_target=None, overwrite=False)

매개 변수

Name Description
workspace
필수
Workspace

웹 서비스를 연결할 작업 영역 개체입니다.
name
필수
str

배포된 서비스를 제공할 이름입니다. 작업 영역에 고유해야 하며 소문자, 숫자 또는 대시로만 구성되고 문자로 시작하며 길이는 3자에서 32자 사이여야 합니다.
model_paths
필수
list[str]

모델 파일 또는 폴더에 대한 디스크 내 경로 목록입니다. 빈 목록이 될 수 있습니다.
image_config
필수
ImageConfig

필요한 Image 속성을 결정하는 데 사용되는 ImageConfig 개체입니다.
deployment_config
WebserviceDeploymentConfiguration

웹 서비스를 구성하는 데 사용되는 WebserviceDeploymentConfiguration입니다. 이 개체가 제공되지 않으면 원하는 대상에 따라 빈 구성 개체가 사용됩니다.

Default value: None
deployment_target
ComputeTarget

ComputeTarget 웹 서비스를 배포할 A입니다. Azure Container Instances에 연결된 ComputeTarget항목이 없으므로 이 매개 변수를 None으로 유지하여 Azure Container Instances에 배포합니다.

Default value: None
overwrite
bool

이름이 있는 서비스가 이미 있는 경우 기존 서비스를 덮어씁니다.

Default value: False

반환

형식 Description
Webservice

배포된 웹 서비스에 해당하는 Webservice 개체입니다.

예외

형식 Description
WebserviceException

deploy_from_image

개체에서 Image 웹 서비스를 배포합니다.

모델에 대해 만든 Image 개체가 이미 있는 경우 이 함수를 사용합니다.

결과 웹 서비스는 유추 요청에 사용할 수 있는 실시간 엔드포인트입니다. 자세한 내용은 웹 서비스로 배포된 모델 사용을 참조하세요.

static deploy_from_image(workspace, name, image, deployment_config=None, deployment_target=None, overwrite=False)

매개 변수

Name Description
workspace
필수
Workspace

웹 서비스를 연결할 작업 영역 개체입니다.
name
필수
str

배포된 서비스를 제공할 이름입니다. 작업 영역에 고유해야 하며 소문자, 숫자 또는 대시로만 구성되고 문자로 시작하며 길이는 3자에서 32자 사이여야 합니다.
image
필수
Image

Image 배포할 개체입니다.
deployment_config
WebserviceDeploymentConfiguration

웹 서비스를 구성하는 데 사용되는 WebserviceDeploymentConfiguration입니다. 이 개체가 제공되지 않으면 원하는 대상에 따라 빈 구성 개체가 사용됩니다.

Default value: None
deployment_target
ComputeTarget

ComputeTarget 웹 서비스를 배포할 A입니다. Azure Container Instances에 연결된 ComputeTarget항목이 없으므로 이 매개 변수를 None으로 유지하여 Azure Container Instances에 배포합니다.

Default value: None
overwrite
bool

이름이 있는 서비스가 이미 있는 경우 기존 서비스를 덮어씁니다.

Default value: False

반환

형식 Description
Webservice

배포된 웹 서비스에 해당하는 Webservice 개체입니다.

예외

형식 Description
WebserviceException

deploy_from_model

0개 이상의 Model 개체에서 웹 서비스를 배포합니다.

이 함수는 유사 deploy하지만 모델을 등록하지는 않습니다. 이미 등록된 모델 개체가 있는 경우 이 함수를 사용합니다. 그러면 지정된 작업 영역과 연결된 프로세스가 이미지를 만듭니다.

결과 웹 서비스는 유추 요청에 사용할 수 있는 실시간 엔드포인트입니다. 자세한 내용은 웹 서비스로 배포된 모델 사용을 참조하세요.

static deploy_from_model(workspace, name, models, image_config, deployment_config=None, deployment_target=None, overwrite=False)

매개 변수

Name Description
workspace
필수
Workspace

웹 서비스를 연결할 작업 영역 개체입니다.
name
필수
str

배포된 서비스를 제공할 이름입니다. 작업 영역에 고유해야 하며 소문자, 숫자 또는 대시로만 구성되고 문자로 시작하며 길이는 3자에서 32자 사이여야 합니다.
models
필수
list[Model]

모델 개체 목록입니다. 빈 목록이 될 수 있습니다.
image_config
필수
ImageConfig

필요한 Image 속성을 결정하는 데 사용되는 ImageConfig 개체입니다.
deployment_config
WebserviceDeploymentConfiguration

웹 서비스를 구성하는 데 사용되는 WebserviceDeploymentConfiguration입니다. 이 개체가 제공되지 않으면 원하는 대상에 따라 빈 구성 개체가 사용됩니다.

Default value: None
deployment_target
ComputeTarget

ComputeTarget 웹 서비스를 배포할 A입니다. ACI에 연결된 ComputeTarget항목이 없으므로 이 매개 변수를 None으로 유지하여 ACI에 배포합니다.

Default value: None
overwrite
bool

이름이 있는 서비스가 이미 있는 경우 기존 서비스를 덮어씁니다.

Default value: False

반환

형식 Description
Webservice

배포된 웹 서비스에 해당하는 Webservice 개체입니다.

예외

형식 Description
WebserviceException

deploy_local_from_model

테스트용으로 빌드 LocalWebservice 및 배포합니다.

Docker를 설치하고 구성해야 합니다.

static deploy_local_from_model(workspace, name, models, image_config, deployment_config=None, wait=False)

매개 변수

Name Description
workspace
필수
Workspace

웹 서비스를 연결할 작업 영역 개체입니다.
name
필수
str

배포된 서비스를 제공할 이름입니다. 로컬 컴퓨터에서 고유해야 합니다.
models
필수
list[Model]

모델 개체 목록입니다. 빈 목록이 될 수 있습니다.
image_config
필수
ImageConfig

필요한 서비스 이미지 속성을 결정하는 데 사용되는 ImageConfig 개체입니다.
deployment_config
LocalWebserviceDeploymentConfiguration

웹 서비스를 구성하는 데 사용되는 LocalWebserviceDeploymentConfiguration입니다. 이 개체가 제공되지 않으면 빈 구성 개체가 사용됩니다.

Default value: None
wait
bool

LocalWebservice의 Docker 컨테이너가 정상으로 보고되기를 기다릴지 여부입니다. 컨테이너가 충돌하는 경우 예외를 throw합니다. 기본값은 False입니다.

Default value: False

반환

형식 Description
LocalWebservice

예외

형식 Description
WebserviceException

deserialize

모델 관리 서비스 응답 JSON 개체를 Webservice 개체로 변환합니다.

제공된 작업 영역이 웹 서비스가 등록된 작업 영역이 아닌 경우 실패합니다.

deserialize(workspace, webservice_payload)

매개 변수

Name Description
cls
필수

클래스 메서드임을 나타냅니다.
workspace
필수
Workspace

웹 서비스가 등록된 작업 영역 개체입니다.
webservice_payload
필수
dict

Webservice 개체로 변환할 JSON 개체입니다.

반환

형식 Description
Webservice

제공된 JSON 개체의 웹 서비스 표현입니다.

get_keys

이 웹 서비스에 대한 인증 키를 검색합니다.

get_keys()

반환

형식 Description
(str, str)

이 웹 서비스에 대한 인증 키입니다.

예외

형식 Description
WebserviceException

get_logs

이 웹 서비스에 대한 로그를 검색합니다.

get_logs(num_lines=5000, init=False)

매개 변수

Name Description
num_lines
int

검색할 최대 로그 줄 수입니다.

Default value: 5000
init
bool

init 컨테이너의 로그 가져오기

Default value: False

반환

형식 Description
str

이 웹 서비스에 대한 로그입니다.

예외

형식 Description
WebserviceException

get_token

현재 사용자로 범위가 지정된 이 웹 서비스에 대한 인증 토큰을 검색합니다.

get_token()

반환

형식 Description
str, datetime

이 웹 서비스에 대한 인증 토큰 및 이후에 새로 고쳐야 하는 시기입니다.

예외

형식 Description
WebserviceException

list

해당 Workspace웹 서비스와 연결된 웹 서비스를 나열합니다.

반환된 결과는 매개 변수를 사용하여 필터링할 수 있습니다.

static list(workspace, compute_type=None, image_name=None, image_id=None, model_name=None, model_id=None, tags=None, properties=None, image_digest=None)

매개 변수

Name Description
workspace
필수
Workspace

웹 서비스를 나열할 Workspace 개체입니다.
compute_type
str

특정 웹 서비스 유형만 나열하도록 필터링합니다. 옵션은 'ACI', 'AKS'입니다.

Default value: None
image_name
str

특정 이미지 이름으로 배포된 웹 서비스만 포함하도록 목록을 필터링합니다.

Default value: None
image_id
str

특정 이미지 ID로 배포된 웹 서비스만 포함하도록 목록을 필터링합니다.

Default value: None
model_name
str

특정 모델 이름으로 배포된 웹 서비스만 포함하도록 목록을 필터링합니다.

Default value: None
model_id
str

특정 모델 ID로 배포된 웹 서비스만 포함하도록 목록을 필터링합니다.

Default value: None
tags
list

제공된 목록을 기준으로 'key' 또는 '[key, value]'를 기준으로 필터링합니다. 예: ['key', ['key2', 'key2 value']]

Default value: None
properties
list

제공된 목록을 기준으로 'key' 또는 '[key, value]'를 기준으로 필터링합니다. 예: ['key', ['key2', 'key2 value']]

Default value: None
image_digest
str

특정 이미지 다이제스트와 함께 배포된 웹 서비스만 포함하도록 목록을 필터링합니다.

Default value: None

반환

형식 Description
list[Webservice]

제공된 작업 영역에서 필터링된 웹 서비스 목록입니다.

예외

형식 Description
WebserviceException

regen_key

웹 서비스의 키 중 하나인 '기본' 또는 '보조' 키를 다시 생성합니다.

지정하지 않았거나 'Primary' 또는 'Secondary'가 아닌 경우 WebserviceException A key 가 발생합니다.

regen_key(key, set_key=None)

매개 변수

Name Description
key
필수
str

다시 생성할 키입니다. 옵션은 '기본' 또는 '보조'입니다.
set_key
str

키 값의 수동 사양을 허용하는 사용자 지정 값

Default value: None

예외

형식 Description
WebserviceException

run

제공된 입력을 사용하여 이 웹 서비스를 호출합니다.

의 Webservice자식 클래스에 의해 구현되는 추상 메서드

abstract run(input)

매개 변수

Name Description
input
필수
<xref:varies>

웹 서비스를 호출할 입력 데이터입니다. 기계 학습 모델이 예측을 실행하기 위한 입력으로 예상하는 데이터입니다.

반환

형식 Description
dict

웹 서비스를 호출한 결과입니다. 그러면 기계 학습 모델에서 실행되는 예측이 반환됩니다.

예외

형식 Description
WebserviceException

serialize

이 Webservice 개체를 JSON 직렬화된 사전으로 변환합니다.

Webservice 개체로 다시 변환하는 데 사용합니다 deserialize .

serialize()

반환

형식 Description
dict

이 웹 서비스의 JSON 표현입니다.

update

웹 서비스 매개 변수를 업데이트합니다.

이 메서드는 자식 클래스에 의해 구현되는 추상 메서드입니다 Webservice. 업데이트할 수 있는 매개 변수는 Webservice 자식 형식에 따라 달라집니다. 예를 들어 Azure Container Instances 웹 서비스의 경우 특정 매개 변수를 참조 update 하세요.

abstract update(*args)

매개 변수

Name Description
args
필수
<xref:varies>

업데이트할 값입니다.

예외

형식 Description
WebserviceException

update_deployment_state

메모리 내 개체의 현재 상태를 새로 고칩니다.

해당 클라우드 개체의 현재 상태에 따라 개체의 속성을 현재 위치로 업데이트합니다. 생성 상태의 수동 폴링에 주로 유용합니다.

update_deployment_state()

wait_for_deployment

실행 중인 웹 서비스 배포에 대해 자동으로 폴링합니다.

웹 서비스가 터미널 상태에 도달할 때까지 기다립니다. 성공하지 못한 터미널 상태에 도달하거나 제공된 시간 제한을 초과하는 경우 throw WebserviceException 됩니다.

wait_for_deployment(show_output=False, timeout_sec=None)

매개 변수

Name Description
show_output
bool

자세한 출력을 인쇄할지 여부를 나타냅니다.

Default value: False
timeout_sec
float

배포가 지정된 시간 제한을 초과하는 경우 예외를 발생합니다.

Default value: None

예외

형식 Description
WebserviceException