Partilhar via


AksWebservice Classe

Representa um modelo de aprendizado de máquina implantado como um ponto de extremidade de serviço Web no Serviço Kubernetes do Azure.

Um serviço implantado é 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.

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 Kubernetes do Azure.

Inicialize a instância do Webservice.

O construtor Webservice recupera uma representação na nuvem de um objeto Webservice associado ao espaço de trabalho 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

Name Description
workspace
Necessário

O objeto de espaço de trabalho que contém o objeto Webservice a ser recuperado.

name
Necessário
str

O nome do objeto Webservice a ser recuperado.

Observações

O padrão de implantação recomendado é criar um objeto de configuração de implantação com o deploy_configuration método e, em seguida, usá-lo com o deploy método da classe, Model 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 método do para modelos já registrados no espaço de Model trabalho.

  • deploy_from_image método de Webservice.

  • deploy_from_model método de para modelos já registrados no espaço de Webservice trabalho. Este método criará uma imagem.

  • deploy método 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 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

Name Description
enable_app_insights

Se o log do AppInsights está habilitado ou não para o WebService.

autoscaler

O objeto Autoscaler para o WebService.

compute_name
str

O nome do ComputeTarget no qual o Webservice é implantado.

container_resource_requirements

Os requisitos de recursos de contêiner para o WebService.

liveness_probe_requirements

Os requisitos de sonda de vivacidade para o WebService.

data_collection

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 WebService.

max_request_wait_time
int

O tempo máximo de espera de solicitação para o WebService, em milissegundos.

num_replicas
int

O número de réplicas para o WebService. Cada réplica corresponde a um pod AKS.

scoring_timeout_ms
int

O tempo limite de pontuação para o Webservice, em milissegundos.

azureml.core.webservice.AksWebservice.scoring_uri
str

O ponto de extremidade de pontuação para o Webservice

is_default

Se o Webservice for a versão padrão para o AksEndpoint pai.

traffic_percentile
int

Qual a percentagem de tráfego a encaminhar para o Webservice no AksEndpoint principal.

version_type

O tipo de versão para o Webservice no AksEndpoint pai.

token_auth_enabled

Se a autenticação de token está habilitada ou não para o WebService.

environment

O objeto Environment que foi usado para criar o WebService.

azureml.core.webservice.AksWebservice.models

Uma lista de Modelos implantados no WebService.

deployment_status
str

O status de implantação do WebService.

namespace
str

O namespace AKS do WebService.

azureml.core.webservice.AksWebservice.swagger_uri
str

O ponto de extremidade swagger para o Webservice.

Métodos

add_properties

Adicione pares de valores de chave ao dicionário de propriedades deste WebService.

add_tags

Adicione pares de valor-chave ao dicionário de tags deste WebService.

Levanta um WebserviceException.

deploy_configuration

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

get_access_token

Recupere o token de autenticação para este WebService.

get_token

PRETERIDO. Use get_access_token o método em vez disso.

Recupere o token de autenticação para este WebService.

remove_tags

Remova as chaves especificadas do dicionário de tags deste WebService.

run

Chame este Webservice com a entrada fornecida.

serialize

Converta este Webservice em um dicionário serializado JSON.

update

Atualize o Webservice com as propriedades fornecidas.

Os valores deixados como Nenhum permanecerão inalterados neste WebService.

add_properties

Adicione pares de valores de chave ao dicionário de propriedades deste WebService.

add_properties(properties)

Parâmetros

Name Description
properties
Necessário

O dicionário de propriedades a adicionar.

add_tags

Adicione pares de valor-chave ao dicionário de tags deste WebService.

Levanta um WebserviceException.

add_tags(tags)

Parâmetros

Name Description
tags
Necessário

O dicionário de tags para adicionar.

Exceções

Tipo Description

deploy_configuration

Crie um objeto de configuração para implantação em um destino de computação 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

Name Description
autoscale_enabled

Ativar ou não o dimensionamento automático para este WebService. O padrão é True se num_replicas for Nenhum.

Default value: None
autoscale_min_replicas
int

O número mínimo de contêineres a serem usados ao dimensionar automaticamente este WebService. O padrão é 1.

Default value: None
autoscale_max_replicas
int

O número máximo de contêineres a serem usados ao dimensionar automaticamente este WebService. O valor padrão é 10.

Default value: None
autoscale_refresh_seconds
int

Com que frequência o autoscaler deve tentar dimensionar este WebService. O padrão é 1.

Default value: None
autoscale_target_utilization
int

A utilização alvo (em percentagem de 100) que o autoscaler deve tentar manter para este WebService. O padrão é 70.

Default value: None
collect_model_data

Se deve ou não habilitar a coleta de dados de modelo para este WebService. A definição padrão é 'False'.

Default value: None
auth_enabled

Ativar ou não a autenticação de chave para este WebService. O padrão é True.

Default value: None
cpu_cores

O número de núcleos de cpu a alocar para este WebService. Pode ser decimal. O padrão é 0.1. Corresponde à solicitação de núcleo do pod, não ao limite, no Serviço Kubernetes do Azure.

Default value: None
memory_gb

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

Default value: None
enable_app_insights

Habilitar ou não o log do Application Insights para este WebService. A definição padrão é 'False'.

Default value: None
scoring_timeout_ms
int

Um tempo limite a ser imposto para marcar chamadas para este WebService. O padrão é 60000.

Default value: None
replica_max_concurrent_requests
int

O número máximo de solicitações simultâneas por réplica para permitir esse WebService. O 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.

Default value: None
max_request_wait_time
int

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

Default value: None
num_replicas
int

O número de contêineres a serem alocados para este WebService. Não há padrão, se esse parâmetro não estiver definido, o autoscaler será habilitado por padrão.

Default value: None
primary_key
str

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

Default value: None
secondary_key
str

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

Default value: None
tags

Dicionário de tags de valor chave para dar a este WebService.

Default value: None
properties

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

Default value: None
description
str

Uma descrição para fornecer este WebService.

Default value: None
gpu_cores
int

O número de núcleos de GPU a alocar para este WebService. O valor padrão é 0.

Default value: None
period_seconds
int

Com que frequência (em segundos) realizar a sonda de vivacidade. O padrão é de 10 segundos. O valor mínimo é 1.

Default value: None
initial_delay_seconds
int

O número de segundos após o início do recipiente antes que as sondas de vivacidade sejam iniciadas. O padrão é 310.

Default value: None
timeout_seconds
int

O número de segundos após os quais a sonda de vivacidade expira. O padrão é de 2 segundos. O valor mínimo é 1.

Default value: None
success_threshold
int

Os sucessos mínimos consecutivos para que a sonda de vivacidade seja considerada bem-sucedida depois de ter falhado. O padrão é 1. O valor mínimo é 1.

Default value: None
failure_threshold
int

Quando um Pod é iniciado e a sonda de vivacidade falha, o Kubernetes tentará failureThreshold vezes antes de desistir. O padrão é 3. O valor mínimo é 1.

Default value: None
namespace
str

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

Default value: None
token_auth_enabled

Se deve ou não ativar a autenticação de token para este WebService. Se isso estiver habilitado, os usuários poderão acessar esse Webservice buscando um token de acesso usando suas credenciais do Azure Ative Directory. A definição padrão é 'False'.

Default value: None
compute_target_name
str

O nome do destino de computação a ser implantado

Default value: None
cpu_cores_limit

O número máximo de núcleos de CPU que este Webservice tem permissão para usar. Pode ser decimal.

Default value: None
memory_gb_limit

A quantidade máxima de memória (em GB) que este Webservice tem permissão para usar. Pode ser decimal.

Default value: None
blobfuse_enabled

Se deve ou não habilitar o blobfuse para download de modelo para este WebService. O padrão é True

Default value: None

Devoluções

Tipo Description

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

Exceções

Tipo Description

get_access_token

Recupere o token de autenticação para este WebService.

get_access_token()

Devoluções

Tipo Description

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

Exceções

Tipo Description

get_token

PRETERIDO. Use get_access_token o método em vez disso.

Recupere o token de autenticação para este WebService.

get_token()

Devoluções

Tipo Description

O token de autenticação para este WebService e quando atualizá-lo.

Exceções

Tipo Description

remove_tags

Remova as chaves especificadas do dicionário de tags deste WebService.

remove_tags(tags)

Parâmetros

Name Description
tags
Necessário

A lista de chaves a remover

run

Chame este Webservice com a entrada fornecida.

run(input_data)

Parâmetros

Name Description
input_data
Necessário
<xref:varies>

A entrada para chamar o WebService com

Devoluções

Tipo Description

O resultado de chamar o WebService

Exceções

Tipo Description

serialize

Converta este Webservice em um dicionário serializado JSON.

serialize()

Devoluções

Tipo Description

A representação JSON deste WebService.

update

Atualize o Webservice com as propriedades fornecidas.

Os valores deixados como Nenhum permanecerão inalterados neste WebService.

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

Name Description
image

Uma nova imagem para implantar no WebService

Default value: None
autoscale_enabled

Habilitar ou desabilitar o dimensionamento automático deste Webservice

Default value: None
autoscale_min_replicas
int

O número mínimo de contêineres a serem usados ao dimensionar automaticamente este WebService

Default value: None
autoscale_max_replicas
int

O número máximo de contêineres a serem usados ao dimensionar automaticamente este WebService

Default value: None
autoscale_refresh_seconds
int

Com que frequência o autoscaler deve tentar dimensionar este Webservice

Default value: None
autoscale_target_utilization
int

A utilização de destino (em percentagem de 100) que o autoscaler deve tentar manter para este Webservice

Default value: None
collect_model_data

Habilitar ou desabilitar a coleta de dados de modelo para este WebService

Default value: None
auth_enabled

Ativar ou não a autenticação para este WebService

Default value: None
cpu_cores

O número de núcleos de cpu a alocar para este WebService. Pode ser decimal

Default value: None
memory_gb

A quantidade de memória (em GB) a alocar para este WebService. Pode ser decimal

Default value: None
enable_app_insights

Se o log do Application Insights deve ou não ser habilitado para este Webservice

Default value: None
scoring_timeout_ms
int

Um tempo limite a ser imposto para marcar chamadas para este WebService

Default value: None
replica_max_concurrent_requests
int

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

Default value: None
max_request_wait_time
int

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

Default value: None
num_replicas
int

O número de contêineres a serem alocados para este WebService

Default value: None
tags

Dicionário de tags de valor chave para dar a este WebService. Substituirá as tags existentes.

Default value: None
properties

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

Default value: None
description
str

Uma descrição para fornecer este WebService

Default value: None
models

Uma lista de objetos Model para empacotar com o serviço atualizado

Default value: None
inference_config

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

Default value: None
gpu_cores
int

O número de núcleos de gpu a alocar para este WebService

Default value: None
period_seconds
int

Com que frequência (em segundos) realizar a sonda de vivacidade. O padrão é de 10 segundos. O valor mínimo é 1.

Default value: None
initial_delay_seconds
int

Número de segundos após o início do recipiente antes que as sondas de vivacidade sejam iniciadas.

Default value: None
timeout_seconds
int

Número de segundos após os quais a sonda de vivacidade expira. O padrão é de 1 segundo. O valor mínimo é 1.

Default value: None
success_threshold
int

Sucessos consecutivos mínimos para que a sonda de vivacidade seja considerada bem-sucedida depois de ter falhado. O padrão é 1. O valor mínimo é 1.

Default value: None
failure_threshold
int

Quando um Pod é iniciado e a sonda de vivacidade falha, o Kubernetes tentará failureThreshold vezes antes de desistir. O padrão é 3. O valor mínimo é 1.

Default value: None
namespace
str

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

Default value: None
token_auth_enabled

Se deve ou não ativar a autenticação de token para este WebService. Se isso estiver habilitado, os usuários poderão acessar esse Webservice buscando o token de acesso usando suas credenciais do Azure Ative Directory. Padrão para False

Default value: None
cpu_cores_limit

O número máximo de núcleos de CPU que este Webservice tem permissão para usar. Pode ser decimal.

Default value: None
memory_gb_limit

A quantidade máxima de memória (em GB) que este Webservice tem permissão para usar. Pode ser decimal.

Default value: None
kwargs
Necessário
<xref:varies>

incluem parâmetros para dar suporte à migração do serviço Web AKS para o endpoint e a implantação online do Kubernetes. is_migration=Verdadeiro|False, compute_target=<destino de computação com a extensão AzureML instalada para hospedar o ponto de extremidade e a implantação online do Kubernetes migrado>.

Exceções

Tipo Description