Webservice Classe

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

O Construtor WebService é usado para recuperar uma representação em 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 implantar modelos de aprendizado de máquina de um Model objeto ou Image .

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

Herança
abc.ABC
Webservice

Construtor

Webservice(workspace, name)

Parâmetros

workspace
Workspace

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

name
<xref:str>

O nome do objeto WebService a ser recuperado.

Comentários

O exemplo a seguir mostra o padrão de implantação recomendado em que você primeiro cria um objeto de configuração com o deploy_configuration método da classe filha de WebService (neste caso AksWebservice ) e, em seguida, usa a configuração com o deploy método da Model 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 completo está disponível em https://github.com/Azure/MachineLearningNotebooks/blob/master/how-to-use-azureml/deployment/production-deploy-to-aks/production-deploy-to-aks.ipynb

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)

O exemplo completo está disponível em https://github.com/Azure/MachineLearningNotebooks/blob/master/how-to-use-azureml/deployment/deploy-to-cloud/model-register-and-deploy.ipynb

Há várias maneiras de implantar um modelo como um WebService, incluindo o:

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

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

  • deploy_from_model método de Webservice para modelos já registrado no espaço de trabalho. Esse 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 WebServices, consulte

A seção de variáveis lista os atributos de uma representação local do objeto WebService de nuvem. Essas variáveis devem ser consideradas somente leitura. Alterar seus valores não será refletido no objeto de nuvem correspondente.

Variáveis

auth_enabled
<xref:bool>

Se o WebService tem ou não a autenticação habilitada.

compute_type
<xref:str>

Em que tipo de computação o WebService é implantado.

created_time
<xref:datetime.datetime>

Quando o WebService foi criado.

azureml.core.Webservice.description

Uma descrição do objeto WebService.

azureml.core.Webservice.tags

Um dicionário de marcas para o objeto WebService.

azureml.core.Webservice.name

O nome do WebService.

azureml.core.Webservice.properties

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

created_by
<xref:str>

O usuário que criou o WebService.

error
<xref:str>

Se o WebService não pôde ser implantado, ele conterá a mensagem de erro para o motivo da falha.

azureml.core.Webservice.state

O estado atual do WebService.

updated_time
<xref:datetime.datetime>

A última vez que o WebService foi atualizado.

azureml.core.Webservice.workspace

O Workspace do Azure Machine Learning que contém este WebService.

token_auth_enabled
<xref:bool>

Se o WebService tem ou não a 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.

Essa chamada de função não é assíncrona. A chamada é executada até que o recurso seja excluído. Um WebserviceException será gerado se houver um problema ao excluir o modelo do serviço de gerenciamento de modelos.

deploy

Implante um WebService de zero ou mais Model objetos.

Essa função registrará todos os arquivos de modelos fornecidos e criará uma imagem no processo, todos associados ao especificado Workspace . Use essa função quando você tiver um diretório de modelos para implantar que não foram 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

Implantar um WebService de um Image objeto.

Use essa função se você já tiver um objeto de imagem 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 de zero ou mais Model objetos.

Essa função é semelhante a deploy , mas não registra os modelos. Use essa 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

Converta um objeto JSON de resposta de Serviço Gerenciamento de Modelos 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 as chaves de autenticação para este WebService.

get_logs

Recuperar logs para este serviço Web.

get_token

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

list

Liste os WebServices associados ao correspondente Workspace .

Os resultados retornados podem ser filtrados usando parâmetros.

regen_key

Regenerar uma das chaves do WebService, a chave ' Primary ' ou ' Secondary '.

Um WebserviceException será gerado se key não for especificado ou não for ' Primary ' ou ' Secondary '.

run

Chame esse webservice com a entrada fornecida.

Método abstrato implementado por classes filhas de Webservice .

serialize

Converter este objeto WebService em um dicionário serializado JSON.

Use deserialize para converter de volta em um objeto WebService.

update

Atualize os parâmetros WebService.

Esse é um método abstrato implementado por classes filhas do Webservice . Os parâmetros possíveis para atualizar variam de acordo com o tipo filho do WebService. Por exemplo, para os serviços de instâncias de contêiner do Azure, consulte update para obter 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. Útil principalmente para sondagem manual do estado de criação.

wait_for_deployment

Sondar automaticamente a implantação do WebService em execução.

Aguarde até que o WebService alcance um estado de terminal. Emitirá um WebserviceException se atingir um estado de terminal não bem-sucedido ou exceder o tempo limite fornecido.

check_for_existing_webservice

Verifique se o WebService existe.

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

Parâmetros

workspace
Workspace
name
<xref:str>
overwrite
<xref:bool>
valor padrão: False
request_func
<xref:function>
valor padrão: None

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

check_func
<xref:function>
valor padrão: None

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

Exceções

delete

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

Essa chamada de função não é assíncrona. A chamada é executada até que o recurso seja excluído. Um WebserviceException será gerado se houver um problema ao excluir o modelo do serviço de gerenciamento de modelos.

delete()

Exceções

deploy

Implante um WebService de zero ou mais Model objetos.

Essa função registrará todos os arquivos de modelos fornecidos e criará uma imagem no processo, todos associados ao especificado Workspace . Use essa função quando você tiver um diretório de modelos para implantar que não foram 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(workspace, name, model_paths, image_config, deployment_config=None, deployment_target=None, overwrite=False)

Parâmetros

workspace
Workspace

Um objeto de espaço de trabalho para associar o WebService.

name
<xref:str>

O nome para fornecer o 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 de comprimento.

model_paths
list[<xref:str>]

Uma lista de caminhos em disco para modelar arquivos ou pastas. Pode ser uma lista vazia.

image_config
ImageConfig

Um objeto ImageConfig usado para determinar as propriedades de imagem necessárias.

deployment_config
WebserviceDeploymentConfiguration
valor padrão: None

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.

deployment_target
ComputeTarget
valor padrão: None

Um ComputeTarget para implantar o WebService no. 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.

overwrite
<xref:bool>
valor padrão: False

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

Retornos

Um objeto WebService correspondente ao serviço Web implantado.

Tipo de retorno

Exceções

deploy_from_image

Implantar um WebService de um Image objeto.

Use essa função se você já tiver um objeto de imagem 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_image(workspace, name, image, deployment_config=None, deployment_target=None, overwrite=False)

Parâmetros

workspace
Workspace

Um objeto de espaço de trabalho para associar o WebService.

name
<xref:str>

O nome para fornecer o 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 de comprimento.

image
Image

Um Image objeto a ser implantado.

deployment_config
WebserviceDeploymentConfiguration
valor padrão: None

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.

deployment_target
ComputeTarget
valor padrão: None

Um ComputeTarget para implantar o WebService no. 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.

overwrite
<xref:bool>
valor padrão: False

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

Retornos

Um objeto WebService correspondente ao serviço Web implantado.

Tipo de retorno

Exceções

deploy_from_model

Implante um WebService de zero ou mais Model objetos.

Essa função é semelhante a deploy , mas não registra os modelos. Use essa 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_from_model(workspace, name, models, image_config, deployment_config=None, deployment_target=None, overwrite=False)

Parâmetros

workspace
Workspace

Um objeto de espaço de trabalho para associar o WebService.

name
<xref:str>

O nome para fornecer o 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 de comprimento.

models
list[Model]

Uma lista de objetos de modelo. Pode ser uma lista vazia.

image_config
ImageConfig

Um objeto ImageConfig usado para determinar as propriedades de imagem necessárias.

deployment_config
WebserviceDeploymentConfiguration
valor padrão: None

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.

deployment_target
ComputeTarget
valor padrão: None

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

overwrite
<xref:bool>
valor padrão: False

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

Retornos

Um objeto WebService correspondente ao serviço Web implantado.

Tipo de retorno

Exceções

deploy_local_from_model

Crie e implante um LocalWebservice para teste.

Requer que o Docker seja instalado e configurado.

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

Parâmetros

workspace
Workspace

Um objeto de espaço de trabalho ao qual associar o WebService.

name
<xref:str>

O nome para fornecer o serviço implantado. Deve ser exclusivo no computador local.

models
list[Model]

Uma lista de objetos de modelo. Pode ser uma lista vazia.

image_config
ImageConfig

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

deployment_config
LocalWebserviceDeploymentConfiguration
valor padrão: None

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

wait
<xref:bool>
valor padrão: False

Se deve aguardar o contêiner do Docker do LocalWebservice para relatar como íntegro. Gera uma exceção se o contêiner falhar. O padrão é False.

Tipo de retorno

Exceções

deserialize

Converta um objeto JSON de resposta de Serviço Gerenciamento de Modelos 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

cls

Indica que se trata de um método de classe.

workspace
Workspace

O objeto de espaço de trabalho no qual o WebService está registrado.

webservice_payload
<xref:dict>

Um objeto JSON a ser convertido em um objeto WebService.

Retornos

A representação WebService do objeto JSON fornecido.

Tipo de retorno

Exceções

get_keys

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

get_keys()

Retornos

As chaves de autenticação para este WebService.

Tipo de retorno

(<xref:str>, <xref:str>)

Exceções

get_logs

Recuperar logs para este serviço Web.

get_logs(num_lines=5000, init=False)

Parâmetros

num_lines
<xref:int>
valor padrão: 5000

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

init
<xref:bool>
valor padrão: False

Obter logs do contêiner de inicialização

Retornos

Os logs para este serviço Web.

Tipo de retorno

<xref:str>

Exceções

get_token

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

get_token()

Retornos

O token de autenticação para este WebService e quando ele deve ser atualizado após.

Tipo de retorno

<xref:str>, <xref:datetime>

Exceções

list

Liste os WebServices associados ao correspondente Workspace .

Os resultados retornados podem ser filtrados usando parâmetros.

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

workspace
Workspace

O objeto de espaço de trabalho para listar os WebServices.

compute_type
<xref:str>
valor padrão: None

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

image_name
<xref:str>
valor padrão: None

Lista de filtros para incluir apenas os WebServices implantados com o nome da imagem específica.

image_id
<xref:str>
valor padrão: None

Lista de filtros para incluir apenas os WebServices implantados com a ID de imagem específica.

model_name
<xref:str>
valor padrão: None

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

model_id
<xref:str>
valor padrão: None

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

tags
list
valor padrão: None

Filtrar com base na lista fornecida, por ' chave ' ou ' [chave, valor] '. Ex. [' Key ', [' Key2 ', ' Key2 value ']]

properties
list
valor padrão: None

Filtrar com base na lista fornecida, por ' chave ' ou ' [chave, valor] '. Ex. [' Key ', [' Key2 ', ' Key2 value ']]

image_digest
<xref:str>
valor padrão: None

Lista de filtros para incluir apenas os WebServices implantados com o resumo da imagem específica.

Retornos

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

Tipo de retorno

Exceções

regen_key

Regenerar uma das chaves do WebService, a chave ' Primary ' ou ' Secondary '.

Um WebserviceException será gerado se key não for especificado ou não for ' Primary ' ou ' Secondary '.

regen_key(key, set_key=None)

Parâmetros

key
<xref:str>

A chave a ser regenerada. As opções são ' Primary ' ou ' Secondary '.

set_key
<xref:str>
valor padrão: None

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

Exceções

run

Chame esse webservice com a entrada fornecida.

Método abstrato implementado por classes filhas de Webservice .

run(input)

Parâmetros

input
<xref:varies>

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

Retornos

O resultado da chamada do WebService. Isso retornará previsões executadas do seu modelo de aprendizado de máquina.

Tipo de retorno

<xref:dict>

Exceções

serialize

Converter este objeto WebService em um dicionário serializado JSON.

Use deserialize para converter de volta em um objeto WebService.

serialize()

Retornos

A representação JSON deste WebService.

Tipo de retorno

<xref:dict>

Exceções

update

Atualize os parâmetros WebService.

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

update(*args)

Parâmetros

args
<xref:varies>

Valores a serem atualizados.

Exceções

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. Útil principalmente para sondagem manual do estado de criação.

update_deployment_state()

Exceções

wait_for_deployment

Sondar automaticamente a implantação do WebService em execução.

Aguarde até que o WebService alcance um estado de terminal. Emitirá um WebserviceException se atingir um estado de terminal não bem-sucedido ou exceder o tempo limite fornecido.

wait_for_deployment(show_output=False, timeout_sec=None)

Parâmetros

show_output
<xref:bool>
valor padrão: False

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

timeout_sec
<xref:float>
valor padrão: None

Gerar uma exceção se a implantação exceder o tempo limite especificado.

Exceções