Compartilhar via

AksWebservice Classe

Representa um modelo de machine learning implantado como um ponto de extremidade de serviço Web no Serviço de Kubernetes do Azure.

Um serviço implantado é criado com base em 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.

O AksWebservice implanta um único serviço em um ponto de extremidade. Para implantar vários serviços em um ponto de extremidade, use a AksEndpoint classe.

Para obter mais informações, consulte Implantar um modelo em um cluster do Serviço de Kubernetes do Azure.

Inicialize a instância do Webservice.

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

Construtor

AksWebservice(workspace, name)

Parâmetros

Nome Description
workspace
Obrigatório
Workspace

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

O nome do objeto webservice a ser recuperado.

Comentários

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


   # 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)

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

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

  • deploy_from_image método de Webservice.

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

  • deploy do Webservicemétodo , 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 atributos de uma representação local do objeto AksWebservice na nuvem. Essas variáveis devem ser consideradas somente leitura. A alteração de seus valores não será refletida no objeto de nuvem correspondente.

Variáveis

Nome Description
enable_app_insights
bool

Se o registro em log do AppInsights está ou não habilitado para o serviço Web.
autoscaler
AutoScaler

O objeto Autoscaler para o webservice.
compute_name
str

O nome do ComputeTarget no qual o serviço Web é implantado.
container_resource_requirements
ContainerResourceRequirements

Os requisitos de recurso de contêiner para o serviço Web.
liveness_probe_requirements
LivenessProbeRequirements

Os requisitos de investigação de atividade para o serviço Web.
data_collection
DataCollection

O objeto DataCollection para o webservice.
max_concurrent_requests_per_container
int

O número máximo de solicitações simultâneas por contêiner para o serviço Web.
max_request_wait_time
int

O tempo máximo de espera da solicitação para o serviço Web, em milissegundos.
num_replicas
int

O número de réplicas para o serviço Web. Cada réplica corresponde a um pod do AKS.
scoring_timeout_ms
int

O tempo limite de pontuação para o serviço Web, em milissegundos.
azureml.core.webservice.AksWebservice.scoring_uri
str

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

Se o webservice for a versão padrão do AksEndpoint pai.
traffic_percentile
int

Qual porcentagem de tráfego rotear para o serviço Web no AksEndpoint pai.
version_type
VersionType

O tipo de versão para o serviço Web no AksEndpoint pai.
token_auth_enabled
bool

Se a autenticação de token está habilitada ou não para o serviço Web.
environment
Environment

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

Uma lista de modelos implantados no serviço Web.
deployment_status
str

O status de implantação do serviço Web.
namespace
str

O namespace do AKS do serviço Web.
azureml.core.webservice.AksWebservice.swagger_uri
str

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

Métodos

add_properties

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

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

Levanta um WebserviceException.
deploy_configuration

Crie um objeto de configuração para implantar em um destino de computação do AKS.
get_access_token

Recupere o token de autenticação para este serviço Web.
get_token

DEPRECADO. Em vez disso, use get_access_token o método.

Recupere o token de autenticação para este serviço Web.
remove_tags

Remova as chaves especificadas do dicionário de marcas desse serviço Web.
run

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

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

Atualize o serviço Web com as propriedades fornecidas.

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

add_properties

Adicione pares de valor de chave 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 serem adicionadas.

add_tags

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

Levanta um WebserviceException.

add_tags(tags)

Parâmetros

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

O dicionário de marcas a serem adicionadas.

Exceções

Tipo Description
WebserviceException

deploy_configuration

Crie um objeto de configuração para implantar em um destino de computação do AKS.

static deploy_configuration(autoscale_enabled=None, autoscale_min_replicas=None, autoscale_max_replicas=None, autoscale_refresh_seconds=None, autoscale_target_utilization=None, collect_model_data=None, auth_enabled=None, cpu_cores=None, memory_gb=None, enable_app_insights=None, scoring_timeout_ms=None, replica_max_concurrent_requests=None, max_request_wait_time=None, num_replicas=None, primary_key=None, secondary_key=None, tags=None, properties=None, description=None, gpu_cores=None, period_seconds=None, initial_delay_seconds=None, timeout_seconds=None, success_threshold=None, failure_threshold=None, namespace=None, token_auth_enabled=None, compute_target_name=None, cpu_cores_limit=None, memory_gb_limit=None, blobfuse_enabled=None)

Parâmetros

Nome Description
autoscale_enabled
bool

Se deseja ou não habilitar o dimensionamento automático para este serviço Web. O padrão será True se num_replicas for None.

Valor padrão: None
autoscale_min_replicas
int

O número mínimo de contêineres a serem usados ao dimensionar automaticamente esse serviço Web. O valor padrão é 1.

Valor padrão: None
autoscale_max_replicas
int

O número máximo de contêineres a serem usados ao dimensionar automaticamente esse serviço Web. O padrão é 10.

Valor padrão: None
autoscale_refresh_seconds
int

Com que frequência o dimensionador automático deve tentar dimensionar esse serviço Web. O valor padrão é 1.

Valor padrão: None
autoscale_target_utilization
int

A utilização de destino (em porcentagem de 100) que o dimensionador automático deve tentar manter para esse serviço Web. O padrão é 70.

Valor padrão: None
collect_model_data
bool

Habilitar ou não a coleta de dados de modelo para este serviço Web. Usa False como padrão.

Valor padrão: None
auth_enabled
bool

Habilitar ou não a autenticação de chave para este serviço Web. O padrão é True.

Valor padrão: None
cpu_cores
float

O número de núcleos de cpu a serem alocados para esse serviço Web. Pode ser um decimal. O padrão é 0.1. Corresponde à solicitação principal do pod, não ao limite, no Serviço de Kubernetes do Azure.

Valor padrão: None
memory_gb
float

A quantidade de memória (em GB) a ser alocada para esse serviço Web. Pode ser um decimal. O padrão é 0,5. Corresponde à solicitação de memória do pod, não ao limite, no Serviço de Kubernetes do Azure.

Valor padrão: None
enable_app_insights
bool

Habilitar ou não o registro em log do Application Insights para esse serviço Web. Usa False como padrão.

Valor padrão: None
scoring_timeout_ms
int

Um tempo limite a ser aplicado para a pontuação de chamadas para esse serviço Web. O padrão é 60000.

Valor padrão: None
replica_max_concurrent_requests
int

O número máximo de solicitações simultâneas por réplica para permitir esse serviço Web. O valor padrão é 1. Não altere essa configuração do valor padrão de 1, a menos que seja instruído pelo Suporte Técnico da Microsoft ou por um membro da equipe do Azure Machine Learning.

Valor padrão: None
max_request_wait_time
int

O tempo máximo que uma solicitação permanecerá na fila (em milissegundos) antes de retornar um erro 503. O padrão é 500.

Valor padrão: None
num_replicas
int

O número de contêineres a serem alocados para esse serviço Web. Sem padrão, se esse parâmetro não for definido, o dimensionador automático será habilitado por padrão.

Valor padrão: None
primary_key
str

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

Valor padrão: None
secondary_key
str

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

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

Dicionário de marcas de valor de chave para fornecer esse serviço Web.

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

Dicionário de propriedades de valor de chave para fornecer esse serviço Web. Essas propriedades não podem ser alteradas após a implantação, no entanto, novos pares de valor de chave podem ser adicionados.

Valor padrão: None
description
str

Uma descrição para fornecer esse serviço Web.

Valor padrão: None
gpu_cores
int

O número de núcleos de GPU a serem alocados para esse serviço Web. O valor padrão é 0.

Valor padrão: None
period_seconds
int

A frequência (em segundos) para realizar a investigação de atividade. Padrão para 10 segundos. O valor mínimo é 1.

Valor padrão: None
initial_delay_seconds
int

O número de segundos após o início do contêiner antes do início das investigações de vida. O padrão é 310.

Valor padrão: None
timeout_seconds
int

O número de segundos após o qual a investigação de vida atinge o tempo limite. O padrão é 2 segundos. O valor mínimo é 1.

Valor padrão: None
success_threshold
int

Os mínimos sucessos consecutivos para que a investigação de vida seja considerada bem-sucedida após ter falhado. O valor padrão é 1. O valor mínimo é 1.

Valor padrão: None
failure_threshold
int

Quando um pod for iniciado e a investigação de atividade falhar, o Kubernetes tentará o failureThreshold vezes antes de desistir. O valor padrão é 3. O valor mínimo é 1.

Valor padrão: None
namespace
str

O namespace do Kubernetes no qual implantar esse serviço Web: até 63 caracteres alfanuméricos minúsculos ('a'-'z', '0'-'9') e hífen ('-'). O primeiro e o último caracteres não podem ser hifens.

Valor padrão: None
token_auth_enabled
bool

Se deseja ou não habilitar a autenticação de token para este serviço Web. Se isso estiver habilitado, os usuários poderão acessar esse serviço Web buscando um token de acesso usando suas credenciais do Azure Active Directory. Usa False como padrão.

Valor padrão: None
compute_target_name
str

O nome do destino de computação para o qual implantar

Valor padrão: None
cpu_cores_limit
float

O número máximo de núcleos de cpu que este serviço Web tem permissão para usar. Pode ser um decimal.

Valor padrão: None
memory_gb_limit
float

A quantidade máxima de memória (em GB) que esse serviço Web tem permissão para usar. Pode ser um decimal.

Valor padrão: None
blobfuse_enabled
bool

Se deseja ou não habilitar o blobfuse para download de modelo para este serviço Web. Padrões como True

Valor padrão: None

Retornos

Tipo Description
AksServiceDeploymentConfiguration

Um objeto de configuração a ser usado ao implantar um AksWebservice.

Exceções

Tipo Description
WebserviceException

get_access_token

Recupere o token de autenticação para este serviço Web.

get_access_token()

Retornos

Tipo Description
AksServiceAccessToken

Um objeto que descreve o token de autenticação para este serviço Web.

Exceções

Tipo Description
WebserviceException

get_token

DEPRECADO. Em vez disso, use get_access_token o método.

Recupere o token de autenticação para este serviço Web.

get_token()

Retornos

Tipo Description
str, datetime

O token de autenticação para esse serviço Web e quando atualizá-lo.

Exceções

Tipo Description
WebserviceException

remove_tags

Remova as chaves especificadas do dicionário de marcas desse serviço Web.

remove_tags(tags)

Parâmetros

Nome Description
tags
Obrigatório
list[str]

A lista de chaves a serem removidas

run

Chame esse serviço Web com a entrada fornecida.

run(input_data)

Parâmetros

Nome Description
input_data
Obrigatório
<xref:varies>

A entrada para chamar o serviço Web com

Retornos

Tipo Description
dict

O resultado de chamar o serviço Web

Exceções

Tipo Description
WebserviceException

serialize

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

serialize()

Retornos

Tipo Description
dict

A representação JSON deste serviço Web.

update

Atualize o serviço Web com as propriedades fornecidas.

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

update(image=None, autoscale_enabled=None, autoscale_min_replicas=None, autoscale_max_replicas=None, autoscale_refresh_seconds=None, autoscale_target_utilization=None, collect_model_data=None, auth_enabled=None, cpu_cores=None, memory_gb=None, enable_app_insights=None, scoring_timeout_ms=None, replica_max_concurrent_requests=None, max_request_wait_time=None, num_replicas=None, tags=None, properties=None, description=None, models=None, inference_config=None, gpu_cores=None, period_seconds=None, initial_delay_seconds=None, timeout_seconds=None, success_threshold=None, failure_threshold=None, namespace=None, token_auth_enabled=None, cpu_cores_limit=None, memory_gb_limit=None, **kwargs)

Parâmetros

Nome Description
image
Image

Uma nova imagem a ser implantada no Webservice

Valor padrão: None
autoscale_enabled
bool

Habilitar ou desabilitar o dimensionamento automático deste serviço Web

Valor padrão: None
autoscale_min_replicas
int

O número mínimo de contêineres a serem usados ao dimensionar automaticamente esse serviço Web

Valor padrão: None
autoscale_max_replicas
int

O número máximo de contêineres a serem usados ao dimensionar automaticamente esse serviço Web

Valor padrão: None
autoscale_refresh_seconds
int

Com que frequência o dimensionador automático deve tentar dimensionar esse serviço Web

Valor padrão: None
autoscale_target_utilization
int

A utilização de destino (em porcentagem de 100) que o dimensionador automático deve tentar manter para esse serviço Web

Valor padrão: None
collect_model_data
bool

Habilitar ou desabilitar a coleta de dados de modelo para este serviço Web

Valor padrão: None
auth_enabled
bool

Se deseja ou não habilitar a autenticação para este serviço Web

Valor padrão: None
cpu_cores
float

O número de núcleos de cpu a serem alocados para esse serviço Web. Pode ser um decimal

Valor padrão: None
memory_gb
float

A quantidade de memória (em GB) a ser alocada para esse serviço Web. Pode ser um decimal

Valor padrão: None
enable_app_insights
bool

Habilitar ou não o registro em log do Application Insights para este serviço Web

Valor padrão: None
scoring_timeout_ms
int

Um tempo limite a ser aplicado para a pontuação de chamadas para este serviço Web

Valor padrão: None
replica_max_concurrent_requests
int

O número máximo de solicitações simultâneas por réplica para permitir esse serviço Web.

Valor padrão: None
max_request_wait_time
int

O tempo máximo que uma solicitação permanecerá na fila (em milissegundos) antes de retornar um erro 503

Valor padrão: None
num_replicas
int

O número de contêineres a serem alocados para este serviço Web

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

Dicionário de marcas de valor de chave para fornecer esse serviço Web. Substituirá as marcas existentes.

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

Dicionário de propriedades de valor de chave a serem adicionadas ao dicionário de propriedades existentes

Valor padrão: None
description
str

Uma descrição para fornecer esse serviço Web

Valor padrão: None
models
list[Model]

Uma lista de objetos Model a serem empacotados com o 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
gpu_cores
int

O número de núcleos de gpu a serem alocados para este serviço Web

Valor padrão: None
period_seconds
int

A frequência (em segundos) para realizar a investigação de atividade. Padrão para 10 segundos. O valor mínimo é 1.

Valor padrão: None
initial_delay_seconds
int

Número de segundos após o início do contêiner antes do início das investigações de atividade.

Valor padrão: None
timeout_seconds
int

Número de segundos após o qual a investigação de vida atinge o tempo limite. O padrão é 1 segundo. O valor mínimo é 1.

Valor padrão: None
success_threshold
int

O mínimo de sucessos consecutivos para que a investigação de atividade seja considerada bem-sucedida após apresentar falha. O valor padrão é 1. O valor mínimo é 1.

Valor padrão: None
failure_threshold
int

Quando um pod for iniciado e a investigação de atividade falhar, o Kubernetes tentará o failureThreshold vezes antes de desistir. O valor padrão é 3. O valor mínimo é 1.

Valor padrão: None
namespace
str

O namespace do Kubernetes no qual implantar esse serviço Web: até 63 caracteres alfanuméricos minúsculos ('a'-'z', '0'-'9') e hífen ('-'). O primeiro e o último caracteres não podem ser hifens.

Valor padrão: None
token_auth_enabled
bool

Se deseja ou não habilitar a autenticação de token para este serviço Web. Se isso estiver habilitado, os usuários poderão acessar esse serviço Web buscando o token de acesso usando suas credenciais do Azure Active Directory. Usa False como padrão

Valor padrão: None
cpu_cores_limit
float

O número máximo de núcleos de cpu que este serviço Web tem permissão para usar. Pode ser um decimal.

Valor padrão: None
memory_gb_limit
float

A quantidade máxima de memória (em GB) que esse serviço Web tem permissão para usar. Pode ser um decimal.

Valor padrão: None
kwargs
Obrigatório
<xref:varies>

inclua parâmetros para dar suporte à migração do serviço Web do AKS para o ponto de extremidade online e a implantação do Kubernetes. is_migration=True|False, compute_target=<compute target with AzureML extension installed to host migrated Kubernetes online endpoint and deployment>.

Exceções

Tipo Description
WebserviceException