Partilhar via

Webservice Classe

Define a funcionalidade base para implantar modelos como pontos de extremidade de serviço Web no Azure Machine Learning.

O construtor Webservice é usado para recuperar uma representação na nuvem de um objeto Webservice associado ao espaço de trabalho fornecido. Retorna uma instância de uma classe filho correspondente ao tipo específico do objeto Webservice recuperado. A classe Webservice permite a implantação de modelos de aprendizado de máquina a partir de um Model ou Image objeto.

Para obter mais informações sobre como trabalhar com Webservice, consulte Implantar modelos com o Azure Machine Learning.

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

Webservice(workspace, name)

Parâmetros

Name Description
workspace
Necessário
Workspace

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.
workspace
Necessário
Workspace

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 exemplo a seguir mostra o padrão de implantação recomendado onde você primeiro cria um objeto de configuração com o deploy_configuration método da classe filho de Webservice (neste caso AksWebservice) e, em seguida, usa a configuração com o deployModel método da classe.


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

O exemplo a seguir mostra como localizar um existente AciWebservice em um espaço de trabalho e excluí-lo se ele existir para que o nome possa ser reutilizado.


   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:

  • deploy método do para modelos já registrados no espaço de Model trabalho.

  • deploy_from_image método de Webservice para imagens já criadas a partir de um modelo.

  • 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 Webservice 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
auth_enabled
bool

Se o Webservice tem ou não a autenticação ativada.
compute_type
str

Em que tipo de computação o Webservice é implantado.
created_time
datetime

Quando o Webservice foi criado.
azureml.core.Webservice.description

Uma descrição do objeto Webservice.
azureml.core.Webservice.tags

Um dicionário de tags para o objeto Webservice.
azureml.core.Webservice.name

O nome do WebService.
azureml.core.Webservice.properties

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

O usuário que criou o WebService.
error
str

Se o Webservice falhou ao implantar, ele conterá a mensagem de erro por que ele falhou.
azureml.core.Webservice.state

O estado atual do WebService.
updated_time
datetime

A última vez que o Webservice foi atualizado.
azureml.core.Webservice.workspace

O Espaço de Trabalho do Azure Machine Learning que contém este WebService.
token_auth_enabled
bool

Se o Webservice tem ou não autenticação de token habilitada.

Métodos

check_for_existing_webservice

Verifique se o webservice existe.
delete

Exclua este Webservice de seu espaço de trabalho associado.

Esta chamada de função não é assíncrona. A chamada é executada até que o recurso seja excluído. A WebserviceException é gerado se houver um problema ao excluir o modelo do Serviço de Gerenciamento de Modelo.
deploy

Implante um Webservice a partir de zero ou mais Model objetos.

Esta função irá registar todos os ficheiros de modelos fornecidos e criar uma imagem no processo, todos associados ao especificado Workspace. Use essa função quando tiver um diretório de modelos para implantar que não tenham sido registrados anteriormente.

O Webservice resultante é um ponto de extremidade em tempo real que pode ser usado para solicitações de inferência. Para obter mais informações, consulte Consumir um modelo implantado como um serviço Web.
deploy_from_image

Implante um Webservice a partir de um Image objeto.

Use esta função se você já tiver um objeto Image criado para um modelo.

O Webservice resultante é um ponto de extremidade em tempo real que pode ser usado para solicitações de inferência. Para obter mais informações, consulte Consumir um modelo implantado como um serviço Web.
deploy_from_model

Implante um Webservice a partir de zero ou mais Model objetos.

Esta função é semelhante ao deploy, mas não regista os modelos. Use esta função se você tiver objetos de modelo que já estão registrados. Isso criará uma imagem no processo, associada ao espaço de trabalho especificado.

O Webservice resultante é um ponto de extremidade em tempo real que pode ser usado para solicitações de inferência. Para obter mais informações, consulte Consumir um modelo implantado como um serviço Web.
deploy_local_from_model

Crie e implante um LocalWebservice para teste.

Requer que o Docker seja instalado e configurado.
deserialize

Converter um objeto JSON de resposta do Serviço de Gerenciamento de Modelo em um objeto Webservice.

Falhará se o espaço de trabalho fornecido não for o espaço de trabalho no qual o Webservice está registrado.
get_keys

Recupere chaves de autenticação para este WebService.
get_logs

Recupere logs para este WebService.
get_token

Recupere o token de autenticação para este WebService, com escopo para o usuário atual.
list

Liste os Webservices associados ao arquivo Workspace.

Os resultados retornados podem ser filtrados usando parâmetros.
regen_key

Regenere uma das chaves do WebService, a chave 'Primária' ou 'Secundária'.

A WebserviceException é levantado se key não for especificado ou não for «Primário» ou «Secundário».
run

Chame este Webservice com a entrada fornecida.

Método abstrato implementado por classes filhas de Webservice.
serialize

Converta este objeto Webservice em um dicionário serializado JSON.

Use deserialize para converter novamente em um objeto Webservice.
update

Atualize os parâmetros do Webservice.

Este é um método abstrato implementado por classes filhas de Webservice. Os parâmetros possíveis para atualizar variam de acordo com o tipo filho do Webservice. Por exemplo, para serviços Web de Instâncias de Contêiner do Azure, consulte update para parâmetros específicos.
update_deployment_state

Atualize o estado atual do objeto na memória.

Execute uma atualização in-loco das propriedades do objeto com base no estado atual do objeto de nuvem correspondente. Principalmente útil para sondagem manual do estado de criação.
wait_for_deployment

Sondar automaticamente na implantação do Webservice em execução.

Aguarde até que o WebService atinja um estado terminal. Lançará um WebserviceException se atingir um estado terminal não bem-sucedido ou exceder o tempo limite fornecido.

check_for_existing_webservice

Verifique se o webservice existe.

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

Parâmetros

Name Description
workspace
Necessário
Workspace
name
Necessário
str
overwrite
bool
Default value: False
request_func
<xref:function>

função para solicitar serviço para verificar se o nome do serviço existe

Default value: None
check_func
<xref:function>

função para verificar o conteúdo de resposta de request_func

Default value: None

Exceções

Tipo Description
WebserviceException

delete

Exclua este Webservice de seu espaço de trabalho associado.

Esta chamada de função não é assíncrona. A chamada é executada até que o recurso seja excluído. A WebserviceException é gerado se houver um problema ao excluir o modelo do Serviço de Gerenciamento de Modelo.

delete()

Exceções

Tipo Description
WebserviceException

deploy

Implante um Webservice a partir de zero ou mais Model objetos.

Esta função irá registar todos os ficheiros de modelos fornecidos e criar uma imagem no processo, todos associados ao especificado Workspace. Use essa função quando tiver um diretório de modelos para implantar que não tenham sido registrados anteriormente.

O Webservice resultante é um ponto de extremidade em tempo real que pode ser usado para solicitações de inferência. Para obter mais informações, consulte Consumir um modelo implantado como um serviço Web.

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

Parâmetros

Name Description
workspace
Necessário
Workspace

Um objeto Workspace ao qual associar o WebService.
name
Necessário
str

O nome a ser dado ao serviço implantado. Deve ser exclusivo para o espaço de trabalho, consistir apenas em letras minúsculas, números ou traços, começar com uma letra e ter entre 3 e 32 caracteres.
model_paths
Necessário
list[str]

Uma lista de caminhos em disco para arquivos ou pastas de modelo. Pode ser uma lista vazia.
image_config
Necessário
ImageConfig

Um objeto ImageConfig usado para determinar as propriedades de Image necessárias.
deployment_config
WebserviceDeploymentConfiguration

Um WebserviceDeploymentConfiguration usado para configurar o webservice. Se um não for fornecido, um objeto de configuração vazio será usado com base no destino desejado.

Default value: None
deployment_target
ComputeTarget

A ComputeTarget para implantar o WebService. Como as Instâncias de Contêiner do Azure não estão associadas ComputeTarget, deixe esse parâmetro como Nenhum para implantar nas Instâncias de Contêiner do Azure.

Default value: None
overwrite
bool

Substitua o serviço existente se o serviço com nome já existir.

Default value: False

Devoluções

Tipo Description
Webservice

Um objeto Webservice correspondente ao webservice implantado.

Exceções

Tipo Description
WebserviceException

deploy_from_image

Implante um Webservice a partir de um Image objeto.

Use esta função se você já tiver um objeto Image criado para um modelo.

O Webservice resultante é um ponto de extremidade em tempo real que pode ser usado para solicitações de inferência. Para obter mais informações, consulte Consumir um modelo implantado como um serviço Web.

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

Parâmetros

Name Description
workspace
Necessário
Workspace

Um objeto Workspace ao qual associar o WebService.
name
Necessário
str

O nome a ser dado ao serviço implantado. Deve ser exclusivo para o espaço de trabalho, consistir apenas em letras minúsculas, números ou traços, começar com uma letra e ter entre 3 e 32 caracteres.
image
Necessário
Image

Um Image objeto a ser implantado.
deployment_config
WebserviceDeploymentConfiguration

Um WebserviceDeploymentConfiguration usado para configurar o webservice. Se um não for fornecido, um objeto de configuração vazio será usado com base no destino desejado.

Default value: None
deployment_target
ComputeTarget

A ComputeTarget para implantar o WebService. Como as Instâncias de Contêiner do Azure não estão associadas ComputeTarget, deixe esse parâmetro como Nenhum para implantar nas Instâncias de Contêiner do Azure.

Default value: None
overwrite
bool

Substitua o serviço existente se o serviço com nome já existir.

Default value: False

Devoluções

Tipo Description
Webservice

Um objeto Webservice correspondente ao webservice implantado.

Exceções

Tipo Description
WebserviceException

deploy_from_model

Implante um Webservice a partir de zero ou mais Model objetos.

Esta função é semelhante ao deploy, mas não regista os modelos. Use esta função se você tiver objetos de modelo que já estão registrados. Isso criará uma imagem no processo, associada ao espaço de trabalho especificado.

O Webservice resultante é um ponto de extremidade em tempo real que pode ser usado para solicitações de inferência. Para obter mais informações, consulte Consumir um modelo implantado como um serviço Web.

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

Parâmetros

Name Description
workspace
Necessário
Workspace

Um objeto Workspace ao qual associar o WebService.
name
Necessário
str

O nome a ser dado ao serviço implantado. Deve ser exclusivo para o espaço de trabalho, consistir apenas em letras minúsculas, números ou traços, começar com uma letra e ter entre 3 e 32 caracteres.
models
Necessário
list[Model]

Uma lista de objetos de modelo. Pode ser uma lista vazia.
image_config
Necessário
ImageConfig

Um objeto ImageConfig usado para determinar as propriedades de Image necessárias.
deployment_config
WebserviceDeploymentConfiguration

Um WebserviceDeploymentConfiguration usado para configurar o webservice. Se um não for fornecido, um objeto de configuração vazio será usado com base no destino desejado.

Default value: None
deployment_target
ComputeTarget

A ComputeTarget para implantar o WebService. Como o ACI não tem nenhum associado ComputeTarget, deixe este parâmetro como Nenhum para implantar no ACI.

Default value: None
overwrite
bool

Substitua o serviço existente se o serviço com nome já existir.

Default value: False

Devoluções

Tipo Description
Webservice

Um objeto Webservice correspondente ao webservice implantado.

Exceções

Tipo Description
WebserviceException

deploy_local_from_model

Crie e implante um LocalWebservice para teste.

Requer que o Docker seja instalado e configurado.

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

Parâmetros

Name Description
workspace
Necessário
Workspace

Um objeto Workspace ao qual associar o WebService.
name
Necessário
str

O nome a ser dado ao serviço implantado. Deve ser exclusivo na máquina local.
models
Necessário
list[Model]

Uma lista de objetos de modelo. Pode ser uma lista vazia.
image_config
Necessário
ImageConfig

Um objeto ImageConfig usado para determinar as propriedades de imagem de serviço necessárias.
deployment_config
LocalWebserviceDeploymentConfiguration

Um LocalWebserviceDeploymentConfiguration usado para configurar o serviço Web. Se um não for fornecido, um objeto de configuração vazio será usado.

Default value: None
wait
bool

Se deve aguardar até que o contêiner Docker do LocalWebservice informe como íntegro. Lança uma exceção se o contêiner falhar. O padrão é False.

Default value: False

Devoluções

Tipo Description
LocalWebservice

Exceções

Tipo Description
WebserviceException

deserialize

Converter um objeto JSON de resposta do Serviço de Gerenciamento de Modelo em um objeto Webservice.

Falhará se o espaço de trabalho fornecido não for o espaço de trabalho no qual o Webservice está registrado.

deserialize(workspace, webservice_payload)

Parâmetros

Name Description
cls
Necessário

Indica que este é um método de classe.
workspace
Necessário
Workspace

O objeto de espaço de trabalho no qual o Webservice está registrado.
webservice_payload
Necessário
dict

Um objeto JSON para converter em um objeto Webservice.

Devoluções

Tipo Description
Webservice

A representação Webservice do objeto JSON fornecido.

get_keys

Recupere chaves de autenticação para este WebService.

get_keys()

Devoluções

Tipo Description
(str, str)

As chaves de autenticação para este WebService.

Exceções

Tipo Description
WebserviceException

get_logs

Recupere logs para este WebService.

get_logs(num_lines=5000, init=False)

Parâmetros

Name Description
num_lines
int

O número máximo de linhas de log a serem recuperadas.

Default value: 5000
init
bool

Obter logs do contêiner init

Default value: False

Devoluções

Tipo Description
str

Os logs para este WebService.

Exceções

Tipo Description
WebserviceException

get_token

Recupere o token de autenticação para este WebService, com escopo para o usuário atual.

get_token()

Devoluções

Tipo Description
str, datetime

O token de autenticação para este Webservice e quando ele deve ser atualizado depois.

Exceções

Tipo Description
WebserviceException

list

Liste os Webservices associados ao arquivo Workspace.

Os resultados retornados podem ser filtrados usando parâmetros.

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)

Parâmetros

Name Description
workspace
Necessário
Workspace

O objeto Workspace para listar os Webservices em.
compute_type
str

Filtre para listar apenas tipos específicos de Webservice. As opções são 'ACI', 'AKS'.

Default value: None
image_name
str

Lista de filtros para incluir apenas Webservices implantados com o nome de imagem específico.

Default value: None
image_id
str

Lista de filtros para incluir apenas Webservices implantados com o ID de imagem específico.

Default value: None
model_name
str

Lista de filtros para incluir apenas Webservices implantados com o nome do modelo específico.

Default value: None
model_id
str

Lista de filtros para incluir apenas Webservices implantados com a ID de modelo específica.

Default value: None
tags
list

Filtre com base na lista fornecida, por 'chave' ou '[chave, valor]'. Ex. ['chave', ['chave2', 'valor da chave2']]

Default value: None
properties
list

Filtre com base na lista fornecida, por 'chave' ou '[chave, valor]'. Ex. ['chave', ['chave2', 'valor da chave2']]

Default value: None
image_digest
str

Lista de filtros para incluir apenas Webservices implantados com o resumo de imagem específico.

Default value: None

Devoluções

Tipo Description
list[Webservice]

Uma lista filtrada de WebServices no espaço de trabalho fornecido.

Exceções

Tipo Description
WebserviceException

regen_key

Regenere uma das chaves do WebService, a chave 'Primária' ou 'Secundária'.

A WebserviceException é levantado se key não for especificado ou não for «Primário» ou «Secundário».

regen_key(key, set_key=None)

Parâmetros

Name Description
key
Necessário
str

A chave para regenerar. As opções são 'Primária' ou 'Secundária'.
set_key
str

Um valor especificado pelo usuário que permite a especificação manual do valor da chave

Default value: None

Exceções

Tipo Description
WebserviceException

run

Chame este Webservice com a entrada fornecida.

Método abstrato implementado por classes filhas de Webservice.

abstract run(input)

Parâmetros

Name Description
input
Necessário
<xref:varies>

Os dados de entrada com os quais chamar o WebService. Esses são os dados que seu modelo de aprendizado de máquina espera como entrada para executar previsões.

Devoluções

Tipo Description
dict

O resultado de chamar o WebService. Isso retornará previsões executadas a partir do seu modelo de aprendizado de máquina.

Exceções

Tipo Description
WebserviceException

serialize

Converta este objeto Webservice em um dicionário serializado JSON.

Use deserialize para converter novamente em um objeto Webservice.

serialize()

Devoluções

Tipo Description
dict

A representação JSON deste WebService.

update

Atualize os parâmetros do Webservice.

Este é um método abstrato implementado por classes filhas de Webservice. Os parâmetros possíveis para atualizar variam de acordo com o tipo filho do Webservice. Por exemplo, para serviços Web de Instâncias de Contêiner do Azure, consulte update para parâmetros específicos.

abstract update(*args)

Parâmetros

Name Description
args
Necessário
<xref:varies>

Valores a atualizar.

Exceções

Tipo Description
WebserviceException

update_deployment_state

Atualize o estado atual do objeto na memória.

Execute uma atualização in-loco das propriedades do objeto com base no estado atual do objeto de nuvem correspondente. Principalmente útil para sondagem manual do estado de criação.

update_deployment_state()

wait_for_deployment

Sondar automaticamente na implantação do Webservice em execução.

Aguarde até que o WebService atinja um estado terminal. Lançará um WebserviceException se atingir um estado terminal não bem-sucedido ou exceder o tempo limite fornecido.

wait_for_deployment(show_output=False, timeout_sec=None)

Parâmetros

Name Description
show_output
bool

Indica se a saída mais detalhada deve ser impressa.

Default value: False
timeout_sec
float

Levante uma exceção se a implantação exceder o tempo limite determinado.

Default value: None

Exceções

Tipo Description
WebserviceException