LocalWebservice Classe
Representa um modelo de machine learning implantado como um ponto de extremidade de serviço Web local.
Implantar serviços Web localmente é útil para cenários de depuração e teste.
Construtor de serviço Web local.
O construtor LocalWebservice é usado para recuperar uma representação local de um objeto LocalWebservice associado ao workspace fornecido.
- Herança
-
LocalWebservice
Construtor
LocalWebservice(*args, **kwargs)
Parâmetros
Nome | Description |
---|---|
workspace
Obrigatório
|
O objeto de workspace que contém qualquer objeto de Modelo que será recuperado. |
name
Obrigatório
|
O nome do objeto do serviço Web a ser recuperado. |
must_exist
Obrigatório
|
Se o serviço Web já deve existir ao criar o objeto na memória. |
workspace
Obrigatório
|
O objeto de workspace que contém qualquer objeto de Modelo que será recuperado. |
name
Obrigatório
|
O nome do objeto LocalWebservice a ser recuperado. |
must_exist
Obrigatório
|
Se o serviço Web já deve existir ao criar o objeto na memória. |
Comentários
Os exemplos de código a seguir mostram como criar um serviço Web local do Docker. Consulte o link do notebook para obter mais detalhes.
from azureml.core.webservice import LocalWebservice
# This is optional, if not provided Docker will choose a random unused port.
deployment_config = LocalWebservice.deploy_configuration(port=6789)
local_service = Model.deploy(ws, "test", [model], inference_config, deployment_config)
local_service.wait_for_deployment()
O exemplo completo está disponível em https://github.com/Azure/MachineLearningNotebooks/blob/master/how-to-use-azureml/deployment/deploy-to-local/register-model-deploy-local.ipynb
Métodos
delete |
Excluir esse LocalWebservice do computador local. Esta chamada de função não é assíncrona. Ele é executado até que o serviço seja excluído. |
deploy_configuration |
Criar um objeto de configuração para implantar um serviço Web local. |
deploy_to_cloud |
Implantar um serviço Web com base na configuração do LocalWebservice. |
deserialize |
Converter um objeto JSON de resposta do Serviço de Gerenciamento de Modelos de Machine Learning em um objeto do serviço Web. Observação Não compatível com LocalWebservice. |
get_keys |
Recuperar as chaves de autenticação para esse serviço Web. Observação Não compatível com LocalWebservice. |
get_logs |
Recuperar os logs para esse LocalWebservice. |
get_token |
Recuperar o token de autenticação para esse serviço Web, com escopo para o usuário atual. Observação Não compatível com LocalWebservice. |
list |
Listar o LocalWebservices associado ao Workspace correspondente. Os resultados retornados podem ser filtrados usando parâmetros. |
regen_key |
Regenerar uma das chaves do serviço Web. Observação Não compatível com LocalWebservice. |
reload |
Recarregar o script de execução e as dependências do LocalWebservice. Isso reinicia o contêiner do serviço com cópias de ativos atualizados, incluindo o script de execução e as dependências locais, mas não recria a imagem subjacente. Da mesma forma, as alterações nas dependências de pip/Conda ou nas etapas personalizadas do Docker não serão refletidas no LocalWebservice recarregado. Para lidar com essas alterações, chame o método update. |
run |
Chamar esse LocalWebservice com a entrada fornecida. |
serialize |
Converter esse objeto do serviço Web em um dicionário serializado JSON. |
update |
Atualizar o LocalWebservice com as propriedades fornecidas. Os valores deixados como None permanecerão inalterados nesse LocalWebservice. |
update_deployment_state |
Atualizar o estado atual do objeto na memória. Executar uma atualização local das propriedades do objeto com base no estado atual do contêiner do Docker local correspondente. |
wait_for_deployment |
Sondar a implantação do LocalWebservice em execução. |
delete
Excluir esse LocalWebservice do computador local.
Esta chamada de função não é assíncrona. Ele é executado até que o serviço seja excluído.
delete(delete_cache=True, delete_image=False, delete_volume=True)
Parâmetros
Nome | Description |
---|---|
delete_cache
Obrigatório
|
Se os arquivos temporários armazenados em cache para o serviço devem ser excluídos. (Padrão: True) |
delete_image
Obrigatório
|
Se a imagem do Docker do serviço deve ser excluída. (Padrão: False) |
delete_volume
Obrigatório
|
Se o volume do Docker do serviço deve ser excluída. (Padrão: True) |
Exceções
Tipo | Description |
---|---|
deploy_configuration
Criar um objeto de configuração para implantar um serviço Web local.
static deploy_configuration(port=None)
Parâmetros
Nome | Description |
---|---|
port
|
A porta local na qual expor o ponto de extremidade HTTP do serviço. Valor padrão: None
|
Retornos
Tipo | Description |
---|---|
Um objeto de configuração a ser usado ao implantar um objeto do serviço Web. |
Exceções
Tipo | Description |
---|---|
deploy_to_cloud
Implantar um serviço Web com base na configuração do LocalWebservice.
deploy_to_cloud(name=None, deployment_config=None, deployment_target=None)
Parâmetros
Nome | Description |
---|---|
name
|
O nome para fornecer o serviço implantado. Deve ser exclusivo para o workspace. Valor padrão: None
|
deployment_config
|
Um WebserviceDeploymentConfiguration usado para configurar o serviço Web. Se um não for fornecido, um objeto de configuração vazio será usado com base no destino desejado. Valor padrão: None
|
deployment_target
|
Um ComputeTarget no qual implantar o serviço Web. Como a ACI não tem ComputeTarget associado, deixe esse parâmetro como None para implantar na ACI. Valor padrão: None
|
Retornos
Tipo | Description |
---|---|
Um objeto do serviço Web correspondente ao serviço Web implantado. |
Exceções
Tipo | Description |
---|---|
deserialize
Converter um objeto JSON de resposta do Serviço de Gerenciamento de Modelos de Machine Learning em um objeto do serviço Web.
Observação
Não compatível com LocalWebservice.
deserialize(workspace, webservice_payload)
Parâmetros
Nome | Description |
---|---|
cls
Obrigatório
|
|
workspace
Obrigatório
|
O objeto de workspace no qual o serviço Web está registrado. |
webservice_payload
Obrigatório
|
Um objeto JSON a ser convertido em um objeto do serviço Web. |
Exceções
Tipo | Description |
---|---|
azureml.exceptions.NotImplementedError
|
get_keys
Recuperar as chaves de autenticação para esse serviço Web.
Observação
Não compatível com LocalWebservice.
get_keys()
Retornos
Tipo | Description |
---|---|
As chaves de autenticação para esse serviço Web. |
Exceções
Tipo | Description |
---|---|
azureml.exceptions.NotImplementedError
|
get_logs
Recuperar os logs para esse LocalWebservice.
get_logs(num_lines=5000, raw=False)
Parâmetros
Nome | Description |
---|---|
num_lines
Obrigatório
|
O número máximo de linhas de log a serem recuperadas. (Padrão: 5000) |
raw
Obrigatório
|
Retornar a saída do contêiner do Docker bruta sem tentar formatá-la. (Padrão: False) |
Retornos
Tipo | Description |
---|---|
Os logs para esse LocalWebservice. |
Exceções
Tipo | Description |
---|---|
get_token
Recuperar o token de autenticação para esse serviço Web, com escopo para o usuário atual.
Observação
Não compatível com LocalWebservice.
get_token()
Retornos
Tipo | Description |
---|---|
O token de autenticação para esse serviço Web e quando ele deverá ser atualizado depois. |
Exceções
Tipo | Description |
---|---|
azureml.exceptions.NotImplementedError
|
list
Listar o LocalWebservices associado ao Workspace correspondente.
Os resultados retornados podem ser filtrados usando parâmetros.
static list(workspace, model_name=None, model_id=None, all=None)
Parâmetros
Nome | Description |
---|---|
workspace
Obrigatório
|
O objeto de workspace associado ao LocalWebservices. |
model_name
|
Filtrar a lista para incluir apenas os LocalWebservices implantados com o nome do modelo específico. Valor padrão: None
|
model_id
|
Filtrar a lista para incluir apenas os LocalWebservices implantados com a ID do modelo específica. Valor padrão: None
|
all
|
Mostra todos os serviços. Somente os serviços em execução são mostrados por padrão. Valor padrão: None
|
Retornos
Tipo | Description |
---|---|
Uma lista filtrada de LocalWebservices associada ao workspace fornecido. |
Exceções
Tipo | Description |
---|---|
regen_key
Regenerar uma das chaves do serviço Web.
Observação
Não compatível com LocalWebservice.
regen_key(key)
Parâmetros
Nome | Description |
---|---|
key
Obrigatório
|
A chave a ser regenerada. As opções são 'Primary' ou 'Secondary' |
Exceções
Tipo | Description |
---|---|
reload
Recarregar o script de execução e as dependências do LocalWebservice.
Isso reinicia o contêiner do serviço com cópias de ativos atualizados, incluindo o script de execução e as dependências locais, mas não recria a imagem subjacente. Da mesma forma, as alterações nas dependências de pip/Conda ou nas etapas personalizadas do Docker não serão refletidas no LocalWebservice recarregado. Para lidar com essas alterações, chame o método update.
reload(wait=False)
Parâmetros
Nome | Description |
---|---|
wait
Obrigatório
|
Aguardar até que o contêiner do serviço atinja um estado de integridade. (Padrão: False) |
Exceções
Tipo | Description |
---|---|
run
Chamar esse LocalWebservice com a entrada fornecida.
run(input_data)
Parâmetros
Nome | Description |
---|---|
input_data
Obrigatório
|
<xref:varies>
A entrada com a qual chamar o LocalWebservice. |
Retornos
Tipo | Description |
---|---|
<xref:varies>
|
O resultado da chamada do LocalWebservice. |
Exceções
Tipo | Description |
---|---|
serialize
Converter esse objeto do serviço Web em um dicionário serializado JSON.
serialize()
Retornos
Tipo | Description |
---|---|
Representação serializada do objeto do serviço Web. |
Exceções
Tipo | Description |
---|---|
update
Atualizar o LocalWebservice com as propriedades fornecidas.
Os valores deixados como None permanecerão inalterados nesse LocalWebservice.
update(models=None, image_config=None, deployment_config=None, wait=False, inference_config=None)
Parâmetros
Nome | Description |
---|---|
models
Obrigatório
|
Uma nova lista de modelos contidos no LocalWebservice. |
image_config
Obrigatório
|
As opções de configuração de imagem a serem aplicadas ao LocalWebservice. |
deployment_config
Obrigatório
|
As opções de configuração de implantação a serem aplicadas ao LocalWebservice. |
inference_config
Obrigatório
|
Um objeto InferenceConfig usado para fornecer as propriedades de implantação de modelo necessárias. |
wait
Obrigatório
|
Aguardar até que o contêiner do serviço atinja um estado de integridade. (Padrão: False) |
Retornos
Tipo | Description |
---|---|
Exceções
Tipo | Description |
---|---|
update_deployment_state
Atualizar o estado atual do objeto na memória.
Executar uma atualização local das propriedades do objeto com base no estado atual do contêiner do Docker local correspondente.
update_deployment_state(must_exist=False)
Parâmetros
Nome | Description |
---|---|
must_exist
|
Se o serviço Web já deve existir ao criar o objeto na memória. Valor padrão: False
|
Exceções
Tipo | Description |
---|---|
wait_for_deployment
Sondar a implantação do LocalWebservice em execução.
wait_for_deployment(show_output=False)
Parâmetros
Nome | Description |
---|---|
show_output
Obrigatório
|
Opção para imprimir uma saída mais detalhada. (Padrão: False) |
Exceções
Tipo | Description |
---|---|
Atributos
port
scoring_uri
swagger_uri
NETWORK_NAME
NETWORK_NAME = 'azureml-local'
STATE_DELETED
STATE_DELETED = 'deleted'
STATE_DEPLOYING
STATE_DEPLOYING = 'deploying'
STATE_FAILED
STATE_FAILED = 'failed'
STATE_RUNNING
STATE_RUNNING = 'running'
STATE_UNKNOWN
STATE_UNKNOWN = 'unknown'