Compartilhar via

AciWebservice Classe

  • Referência

Representa um modelo de machine learning implantado como um ponto de extremidade de serviço Web em Instâncias de Contêiner do Azure.

Um serviço implementado é criado a partir de um modelo, script e arquivos associados. O serviço Web resultante é um ponto de extremidade HTTP com balanceamento de carga com uma API REST. Você pode enviar dados para essa API e receber a previsão retornada pelo modelo.

Para obter mais informações, confira o documento Implantar um modelo nas Instâncias de Contêiner do Azure.

Inicialize a instância do serviço Web.

O construtor webservice recupera uma representação na nuvem de um objeto de serviço Web associado ao workspace fornecido. Ele retornará uma instância de uma classe filho correspondente ao tipo específico do objeto webservice recuperado.

Herança
Webservice
AciWebservice

Construtor

AciWebservice(workspace, name)

Parâmetros

Nome Description
workspace
Obrigatório
Workspace

O objeto de workspace que contém o objeto de serviço Web a ser recuperado.
name
Obrigatório
str

O nome do objeto de serviço Web a ser recuperado.

Comentários

O padrão de implantação recomendado é criar um objeto de configuração de implantação com o método deploy_configuration e, em seguida, usá-lo com o método deploy da classe Model, conforme mostrado abaixo.


   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)

Há várias maneiras de implantar um modelo como um serviço Web, inclusive com:

  • o método deploy do Model para modelos já registrados no workspace.

  • o método deploy_from_image do Webservice.

  • o método deploy_from_model do Webservice para modelos já registrados no workspace. Esse método criará uma imagem.

  • o método deploy do Webservice, que registrará um modelo e criará uma imagem.

Para obter informações sobre como trabalhar com serviços Web, consulte

A seção Variáveis lista os atributos de uma representação local do objeto AciWebservice na nuvem. Essas variáveis devem ser consideradas somente leitura. Alterar os valores delas não se refletirá no objeto de nuvem correspondente.

Variáveis

Nome Description
enable_app_insights
bool

Se o log do AppInsights está habilitado ou não para o serviço Web.
cname
str

O cname do serviço Web.
container_resource_requirements
ContainerResourceRequirements

Os requisitos de recursos do contêiner do serviço Web.
encryption_properties
EncryptionProperties

As propriedades de criptografia do serviço Web.
vnet_configuration
VnetConfiguration

As propriedades da rede virtual do serviço Web; a configuração deve ser criada e fornecida pelo usuário.
azureml.core.webservice.AciWebservice.location
str

O local em que o serviço Web é implantado.
public_ip
str

O endereço IP público do serviço Web.
azureml.core.webservice.AciWebservice.scoring_uri
str

O ponto de extremidade de pontuação para o serviço Web
ssl_enabled
bool

Se o SSL está habilitado ou não para o serviço Web
public_fqdn
str

O FQDN público para o serviço Web
environment
Environment

O objeto Environment que foi usado para criar o serviço Web
azureml.core.webservice.AciWebservice.models
list[Model]

Uma lista de modelos implantados no serviço Web
azureml.core.webservice.AciWebservice.swagger_uri
str

O ponto de extremidade do swagger para o serviço Web

Métodos

add_properties

Adiciona pares chave-valor ao dicionário de propriedades desse serviço Web.
add_tags

Adiciona pares de chave-valor ao dicionário de marcas desse serviço Web.
deploy_configuration

Cria um objeto de configuração para implantar um AciWebservice.
get_token

Recuperar o token de autenticação para esse serviço Web, com escopo para o usuário atual.

Observação

Não implementado.
remove_tags

Remove as chaves especificadas do dicionário de marcas deste serviço Web.
run

Chamar esse serviço Web com a entrada fornecida.
serialize

Converte esse serviço Web em um dicionário serializado JSON.
update

Atualiza o serviço Web com as propriedades fornecidas.

Os valores deixados como None permanecerão inalterados neste serviço Web.

add_properties

Adiciona pares chave-valor ao dicionário de propriedades desse serviço Web.

add_properties(properties)

Parâmetros

Nome Description
properties
Obrigatório
dict[str, str]

O dicionário de propriedades a adicionar.

add_tags

Adiciona pares de chave-valor ao dicionário de marcas desse serviço Web.

add_tags(tags)

Parâmetros

Nome Description
tags
Obrigatório
dict[str, str]

O dicionário de marcas a adicionar.

Exceções

Tipo Description
WebserviceException

deploy_configuration

Cria um objeto de configuração para implantar um AciWebservice.

static deploy_configuration(cpu_cores=None, memory_gb=None, tags=None, properties=None, description=None, location=None, auth_enabled=None, ssl_enabled=None, enable_app_insights=None, ssl_cert_pem_file=None, ssl_key_pem_file=None, ssl_cname=None, dns_name_label=None, primary_key=None, secondary_key=None, collect_model_data=None, cmk_vault_base_url=None, cmk_key_name=None, cmk_key_version=None, vnet_name=None, subnet_name=None)

Parâmetros

Nome Description
cpu_cores
float

O número de núcleos de CPU a serem alocados para esse serviço Web. Pode ser um decimal. O valor padrão é 0,1

Valor padrão: None
memory_gb
float

A quantidade de memória (em GB) alocada para esse serviço Web. Pode ser um decimal. O valor padrão é 0.5

Valor padrão: None
tags
dict[str, str]

Um dicionário de marcas de chave-valor a serem fornecidas a esse serviço Web.

Valor padrão: None
properties
dict[str, str]

Um dicionário de propriedades de chave-valor a serem fornecidas a esse serviço Web. Essas propriedades não podem ser alteradas após a implantação, no entanto, novos pares de chave/valor podem ser adicionados.

Valor padrão: None
description
str

Uma descrição a ser fornecida a esse serviço Web.

Valor padrão: None
location
str

A região do Azure na qual implantar esse serviço Web. Se não for especificado, o local do workspace será usado. Para obter mais detalhes sobre as regiões disponíveis, consulte Produtos por região.

Valor padrão: None
auth_enabled
bool

Se a autenticação deve ou não ser habilitada para esse serviço Web. Usa False como padrão.

Valor padrão: None
ssl_enabled
bool

Se o SSL deve ser habilitado ou não para esse serviço Web. Usa False como padrão.

Valor padrão: None
enable_app_insights
bool

Se o AppInsights deve ser habilitado ou não para esse serviço Web. Usa False como padrão.

Valor padrão: None
ssl_cert_pem_file
str

O arquivo de certificado necessário se o SSL estiver habilitado.

Valor padrão: None
ssl_key_pem_file
str

O arquivo de chave necessário se o SSL estiver habilitado.

Valor padrão: None
ssl_cname
str

O cname a ser usado se o SSL estiver habilitado.

Valor padrão: None
dns_name_label
str

O rótulo de nome DNS do ponto de extremidade de pontuação. Se ele não for especificado, um rótulo de nome DNS exclusivo será gerado para o ponto de extremidade de pontuação.

Valor padrão: None
primary_key
str

Uma chave de autenticação primária a ser usada para esse serviço Web.

Valor padrão: None
secondary_key
str

Uma chave de autenticação secundária a ser usada para esse serviço Web.

Valor padrão: None
collect_model_data
bool

Se a coleta de dados de modelo deve ou não ser habilitada para o serviço Web.

Valor padrão: None
cmk_vault_base_url
str

URL base do cofre de chaves gerenciadas pelo cliente

Valor padrão: None
cmk_key_name
str

O nome da chave gerenciada pelo cliente.

Valor padrão: None
cmk_key_version
str

Versão da chave gerenciada pelo cliente.

Valor padrão: None
vnet_name
str

O nome da rede virtual.

Valor padrão: None
subnet_name
str

O nome da sub-rede na rede virtual.

Valor padrão: None

Retornos

Tipo Description
AciServiceDeploymentConfiguration

Um objeto de configuração a ser usado ao implantar um objeto do serviço Web.

Exceções

Tipo Description
WebserviceException

get_token

Recuperar o token de autenticação para esse serviço Web, com escopo para o usuário atual.

Observação

Não implementado.

get_token()

Retornos

Tipo Description
str, datetime

O token de autenticação para esse serviço Web e quando ele deverá ser atualizado depois.

Exceções

Tipo Description
azureml.exceptions.NotImplementedError

remove_tags

Remove as chaves especificadas do dicionário de marcas deste serviço Web.

remove_tags(tags)

Parâmetros

Nome Description
tags
Obrigatório
list[str]

A lista de chaves a serem removidas.

run

Chamar esse serviço Web com a entrada fornecida.

run(input_data)

Parâmetros

Nome Description
input_data
Obrigatório
<xref:varies>

A entrada com a qual chamar o serviço Web.

Retornos

Tipo Description
dict

O resultado da chamada ao serviço Web.

Exceções

Tipo Description
WebserviceException

serialize

Converte esse serviço Web em um dicionário serializado JSON.

serialize()

Retornos

Tipo Description
dict

A representação JSON desse objeto de serviço Web.

update

Atualiza o serviço Web com as propriedades fornecidas.

Os valores deixados como None permanecerão inalterados neste serviço Web.

update(image=None, tags=None, properties=None, description=None, auth_enabled=None, ssl_enabled=None, ssl_cert_pem_file=None, ssl_key_pem_file=None, ssl_cname=None, enable_app_insights=None, models=None, inference_config=None)

Parâmetros

Nome Description
image
Image

Uma nova imagem a ser implantada no serviço Web.

Valor padrão: None
tags
dict[str, str]

Um dicionário de marcas de chave-valor a serem fornecidas a esse serviço Web. Substituirá as marcas existentes.

Valor padrão: None
properties
dict[str, str]

Um dicionário de propriedades de chave-valor para adicionar ao dicionário de propriedades existente.

Valor padrão: None
description
str

Uma descrição a ser fornecida a esse serviço Web.

Valor padrão: None
auth_enabled
bool

Habilita ou desabilita a autenticação para este serviço Web.

Valor padrão: None
ssl_enabled
bool

Se o SSL deve ser habilitado ou não para esse serviço Web.

Valor padrão: None
ssl_cert_pem_file
str

O arquivo de certificado necessário se o SSL estiver habilitado.

Valor padrão: None
ssl_key_pem_file
str

O arquivo de chave necessário se o SSL estiver habilitado.

Valor padrão: None
ssl_cname
str

O cname a ser usado se o SSL estiver habilitado.

Valor padrão: None
enable_app_insights
bool

Se o AppInsights deve ser habilitado ou não para esse serviço Web.

Valor padrão: None
models
list[Model]

Uma lista de objetos de modelo para empacotar no serviço atualizado.

Valor padrão: None
inference_config
InferenceConfig

Um objeto InferenceConfig usado para fornecer as propriedades de implantação de modelo necessárias.

Valor padrão: None

Retornos

Tipo Description
None