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

Webservice

LocalWebservice

Construtor

LocalWebservice(*args, **kwargs)

Parâmetros

workspace

Workspace

Obrigatório

O objeto de workspace que contém qualquer objeto de Modelo que será recuperado.

name

str

Obrigatório

O nome do objeto do serviço Web a ser recuperado.

must_exist

bool

Obrigatório

Se o serviço Web já deve existir ao criar o objeto na memória.

workspace

Workspace

Obrigatório

O objeto de workspace que contém qualquer objeto de Modelo que será recuperado.

name

str

Obrigatório

O nome do objeto LocalWebservice a ser recuperado.

must_exist

bool

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

delete_cache

bool

Obrigatório

Se os arquivos temporários armazenados em cache para o serviço devem ser excluídos. (Padrão: True)

delete_image

bool

Obrigatório

Se a imagem do Docker do serviço deve ser excluída. (Padrão: False)

delete_volume

bool

Obrigatório

Se o volume do Docker do serviço deve ser excluída. (Padrão: True)

Exceções

WebserviceException

deploy_configuration

Criar um objeto de configuração para implantar um serviço Web local.

static deploy_configuration(port=None)

Parâmetros

port

int

valor padrão: None

A porta local na qual expor o ponto de extremidade HTTP do serviço.

Retornos

Um objeto de configuração a ser usado ao implantar um objeto do serviço Web.

Tipo de retorno

LocalWebserviceDeploymentConfiguration

Exceções

WebserviceException

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

name

str

valor padrão: None

O nome para fornecer o serviço implantado. Deve ser exclusivo para o workspace.

deployment_config

WebserviceDeploymentConfiguration

valor padrão: None

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.

deployment_target

ComputeTarget

valor padrão: None

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.

Retornos

Um objeto do serviço Web correspondente ao serviço Web implantado.

Tipo de retorno

Webservice

Exceções

WebserviceException

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

cls

Obrigatório

workspace

Workspace

Obrigatório

O objeto de workspace no qual o serviço Web está registrado.

webservice_payload

dict

Obrigatório

Um objeto JSON a ser convertido em um objeto do serviço Web.

Exceções

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

As chaves de autenticação para esse serviço Web.

Exceções

azureml.exceptions.NotImplementedError

get_logs

Recuperar os logs para esse LocalWebservice.

get_logs(num_lines=5000, raw=False)

Parâmetros

num_lines

int

Obrigatório

O número máximo de linhas de log a serem recuperadas. (Padrão: 5000)

raw

bool

Obrigatório

Retornar a saída do contêiner do Docker bruta sem tentar formatá-la. (Padrão: False)

Retornos

Os logs para esse LocalWebservice.

Tipo de retorno

str

Exceções

WebserviceException

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

O token de autenticação para esse serviço Web e quando ele deverá ser atualizado depois.

Tipo de retorno

str, datetime

Exceções

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

workspace

Workspace

Obrigatório

O objeto de workspace associado ao LocalWebservices.

model_name

str

valor padrão: None

Filtrar a lista para incluir apenas os LocalWebservices implantados com o nome do modelo específico.

model_id

str

valor padrão: None

Filtrar a lista para incluir apenas os LocalWebservices implantados com a ID do modelo específica.

all

bool

valor padrão: None

Mostra todos os serviços. Somente os serviços em execução são mostrados por padrão.

Retornos

Uma lista filtrada de LocalWebservices associada ao workspace fornecido.

Tipo de retorno

list[LocalWebservice]

Exceções

WebserviceException

regen_key

Regenerar uma das chaves do serviço Web.

Observação

Não compatível com LocalWebservice.

regen_key(key)

Parâmetros

key

str

Obrigatório

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

Exceções

NotImplementedError

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

wait

bool

Obrigatório

Aguardar até que o contêiner do serviço atinja um estado de integridade. (Padrão: False)

Exceções

WebserviceException

run

Chamar esse LocalWebservice com a entrada fornecida.

run(input_data)

Parâmetros

input_data

<xref:varies>

Obrigatório

A entrada com a qual chamar o LocalWebservice.

Retornos

O resultado da chamada do LocalWebservice.

Tipo de retorno

<xref:varies>

Exceções

WebserviceException

serialize

Converter esse objeto do serviço Web em um dicionário serializado JSON.

serialize()

Retornos

Representação serializada do objeto do serviço Web.

Tipo de retorno

dict

Exceções

WebserviceException

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

models

list[Model]

Obrigatório

Uma nova lista de modelos contidos no LocalWebservice.

image_config

ContainerImageConfig

Obrigatório

As opções de configuração de imagem a serem aplicadas ao LocalWebservice.

deployment_config

LocalWebserviceDeploymentConfiguration

Obrigatório

As opções de configuração de implantação a serem aplicadas ao LocalWebservice.

inference_config

InferenceConfig

Obrigatório

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

wait

bool

Obrigatório

Aguardar até que o contêiner do serviço atinja um estado de integridade. (Padrão: False)

Tipo de retorno

None

Exceções

WebserviceException

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

must_exist

bool

valor padrão: False

Se o serviço Web já deve existir ao criar o objeto na memória.

Exceções

WebserviceException

wait_for_deployment

Sondar a implantação do LocalWebservice em execução.

wait_for_deployment(show_output=False)

Parâmetros

show_output

bool

Obrigatório

Opção para imprimir uma saída mais detalhada. (Padrão: False)

Exceções

WebserviceException

Atributos

port

Obter a porta do serviço Web local.

Retornos

Número da porta.

Tipo de retorno

int

scoring_uri

Obter o URI de pontuação do serviço Web local.

Retornos

URI de pontuação.

Tipo de retorno

str

swagger_uri

Obter o URI do Swagger do serviço Web local.

Retornos

URI do Swagger.

Tipo de retorno

str

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'