LocalWebservice Clase

Representa un modelo de Machine Learning implementado como un punto de conexión de servicio web local.

La implementación local de servicios web es útil para escenarios de depuración y pruebas.

Constructor de servicios web local.

El constructor LocalWebservice se usa para recuperar una representación local de un objeto LocalWebservice asociado al área de trabajo proporcionada.

Herencia

Webservice

LocalWebservice

Constructor

LocalWebservice(*args, **kwargs)

Parámetros

workspace

Workspace

Requerido

Objeto Workspace que contiene los objetos de modelo que se van a recuperar.

name

str

Requerido

Nombre del objeto Webservice que se va a recuperar.

must_exist

bool

Requerido

Indica si el servicio web ya debe existir al crear el objeto en memoria.

workspace

Workspace

Requerido

Objeto Workspace que contiene los objetos de modelo que se van a recuperar.

name

str

Requerido

Nombre del objeto LocalWebservice que se va a recuperar.

must_exist

bool

Requerido

Indica si el servicio web ya debe existir al crear el objeto en memoria.

Comentarios

En los ejemplos de código siguientes, se muestra cómo crear un servicio web de Docker local. Consulte el vínculo del cuaderno para obtener más detalles.

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

El ejemplo completo está disponible en https://github.com/Azure/MachineLearningNotebooks/blob/master/how-to-use-azureml/deployment/deploy-to-local/register-model-deploy-local.ipynb.

Métodos

delete	Elimina este servicio LocalWebservice del equipo local. Esta llamada de función no es asincrónica; se ejecuta hasta que se elimina el servicio.
deploy_configuration	Crea un objeto de configuración para implementar un objeto Webservice local.
deploy_to_cloud	Implementa un objeto Webservice basado en la configuración de LocalWebservice.
deserialize	Convierte un objeto JSON de respuesta del servicio de administración de modelos en un objeto Webservice. Nota No se admite para LocalWebservice.
get_keys	Recupera las claves de autenticación para este objeto Webservice. Nota No se admite para LocalWebservice.
get_logs	Recupera los registros de este servicio LocalWebservice.
get_token	Se recupera el token de autenticación de este Webservice, limitado al usuario actual. Nota No se admite para LocalWebservice.
list	Enumera los servicios LocalWebservices asociados al objeto Workspace correspondiente. Los resultados devueltos se pueden filtrar mediante parámetros.
regen_key	Vuelve a generar una de las claves del objeto Webservice. Nota No se admite para LocalWebservice.
reload	Vuelve a cargar el script de ejecución y las dependencias de LocalWebservice. Esto reinicia el contenedor del servicio con copias de los recursos actualizados, incluidos el script de ejecución y las dependencias locales, pero no vuelve a generar la imagen subyacente. En consecuencia, los cambios en las dependencias de Conda y pip o en los pasos personalizados de Docker no se reflejarán en el servicio LocalWebservice recargado. Para controlar esos cambios, llame al método update en su lugar.
run	Llama a este servicio LocalWebservice con la entrada proporcionada.
serialize	Convierte este objeto Webservice en un diccionario serializado JSON.
update	Actualiza LocalWebservice con las propiedades proporcionadas. Los valores que se dejan como None permanecerán sin cambios en este servicio LocalWebservice.
update_deployment_state	Actualiza el estado actual del objeto en memoria. Realiza una actualización local de las propiedades del objeto en función del estado actual del contenedor Docker local correspondiente.
wait_for_deployment	Sondea la implementación de LocalWebservice en ejecución.

delete

Elimina este servicio LocalWebservice del equipo local.

Esta llamada de función no es asincrónica; se ejecuta hasta que se elimina el servicio.

delete(delete_cache=True, delete_image=False, delete_volume=True)

Parámetros

delete_cache

bool

Requerido

Indica si se van a eliminar los archivos temporales almacenados en caché para el servicio. (Valor predeterminado: Verdadero)

delete_image

bool

Requerido

Indica si se va a eliminar la imagen de Docker del servicio. (Valor predeterminado: False)

delete_volume

bool

Requerido

Indica si se va a eliminar el volumen de Docker del servicio. (Valor predeterminado: Verdadero)

Excepciones

WebserviceException

deploy_configuration

Crea un objeto de configuración para implementar un objeto Webservice local.

static deploy_configuration(port=None)

Parámetros

port

int

valor predeterminado: None

Puerto local en el que se va a exponer el punto de conexión HTTP del servicio.

Devoluciones

Objeto de configuración que se usará al implementar un objeto Webservice.

Tipo de valor devuelto

LocalWebserviceDeploymentConfiguration

Excepciones

WebserviceException

deploy_to_cloud

Implementa un objeto Webservice basado en la configuración de LocalWebservice.

deploy_to_cloud(name=None, deployment_config=None, deployment_target=None)

Parámetros

name

str

valor predeterminado: None

Nombre que se va a dar al servicio implementado. Debe ser único para el área de trabajo.

deployment_config

WebserviceDeploymentConfiguration

valor predeterminado: None

Objeto WebserviceDeploymentConfiguration que se usa para configurar el servicio web. Si no se proporciona ninguno, se usará un objeto de configuración vacío en función del destino deseado.

deployment_target

ComputeTarget

valor predeterminado: None

Elemento ComputeTarget en el que se va a implementar el objeto Webservice. Dado que ACI no tiene un elemento ComputeTarget asociado, deje este parámetro como None para la implementación en ACI.

Devoluciones

Objeto Webservice correspondiente al servicio web implementado.

Tipo de valor devuelto

Webservice

Excepciones

WebserviceException

deserialize

Convierte un objeto JSON de respuesta del servicio de administración de modelos en un objeto Webservice.

Nota

No se admite para LocalWebservice.

deserialize(workspace, webservice_payload)

Parámetros

cls

Requerido

workspace

Workspace

Requerido

Objeto Workspace en el que está registrado el objeto Webservice.

webservice_payload

dict

Requerido

Objeto JSON que se va a convertir en un objeto Webservice.

Excepciones

azureml.exceptions.NotImplementedError

get_keys

Recupera las claves de autenticación para este objeto Webservice.

Nota

No se admite para LocalWebservice.

get_keys()

Devoluciones

Claves de autenticación para este objeto Webservice.

Excepciones

azureml.exceptions.NotImplementedError

get_logs

Recupera los registros de este servicio LocalWebservice.

get_logs(num_lines=5000, raw=False)

Parámetros

num_lines

int

Requerido

Número máximo de líneas de registro que se van a recuperar. (Valor predeterminado: 5000)

raw

bool

Requerido

Devuelve la salida del contenedor Docker sin procesar sin intentar darle formato. (Valor predeterminado: False)

Devoluciones

Registros de este servicio LocalWebservice.

Tipo de valor devuelto

str

Excepciones

WebserviceException

get_token

Se recupera el token de autenticación de este Webservice, limitado al usuario actual.

Nota

No se admite para LocalWebservice.

get_token()

Devoluciones

Token de autenticación para este Webservice y cuándo se debe actualizar después.

Tipo de valor devuelto

str, datetime

Excepciones

azureml.exceptions.NotImplementedError

list

Enumera los servicios LocalWebservices asociados al objeto Workspace correspondiente.

Los resultados devueltos se pueden filtrar mediante parámetros.

static list(workspace, model_name=None, model_id=None, all=None)

Parámetros

workspace

Workspace

Requerido

Objeto Workspace asociado a LocalWebservices.

model_name

str

valor predeterminado: None

Filtra la lista para que incluya solo los objetos LocalWebservices implementados con el nombre del modelo específico.

model_id

str

valor predeterminado: None

Filtra la lista para que incluya solo los objetos LocalWebservices implementados con el identificador del modelo específico.

all

bool

valor predeterminado: None

Muestra todos los servicios. De forma predeterminada, solo se muestran los servicios en ejecución.

Devoluciones

Lista filtrada de objetos LocalWebservices asociada al objeto Workspace proporcionado.

Tipo de valor devuelto

list[LocalWebservice]

Excepciones

WebserviceException

regen_key

Vuelve a generar una de las claves del objeto Webservice.

Nota

No se admite para LocalWebservice.

regen_key(key)

Parámetros

key

str

Requerido

Indica qué clave se va a regenerar. Las opciones son "Primary" (Principal) o "Secondary" (Secundaria).

Excepciones

NotImplementedError

reload

Vuelve a cargar el script de ejecución y las dependencias de LocalWebservice.

Esto reinicia el contenedor del servicio con copias de los recursos actualizados, incluidos el script de ejecución y las dependencias locales, pero no vuelve a generar la imagen subyacente. En consecuencia, los cambios en las dependencias de Conda y pip o en los pasos personalizados de Docker no se reflejarán en el servicio LocalWebservice recargado. Para controlar esos cambios, llame al método update en su lugar.

reload(wait=False)

Parámetros

wait

bool

Requerido

Espera a que el contenedor del servicio alcance un estado correcto. (Valor predeterminado: False)

Excepciones

WebserviceException

run

Llama a este servicio LocalWebservice con la entrada proporcionada.

run(input_data)

Parámetros

input_data

<xref:varies>

Requerido

Entrada con la que se va a llamar a LocalWebservice.

Devoluciones

Resultado de llamar a LocalWebservice.

Tipo de valor devuelto

<xref:varies>

Excepciones

WebserviceException

serialize

Convierte este objeto Webservice en un diccionario serializado JSON.

serialize()

Devoluciones

Representación serializada del objeto Webservice.

Tipo de valor devuelto

dict

Excepciones

WebserviceException

update

Actualiza LocalWebservice con las propiedades proporcionadas.

Los valores que se dejan como None permanecerán sin cambios en este servicio LocalWebservice.

update(models=None, image_config=None, deployment_config=None, wait=False, inference_config=None)

Parámetros

models

list[Model]

Requerido

Nueva lista de modelos contenidos en LocalWebservice.

image_config

ContainerImageConfig

Requerido

Opciones de configuración de imágenes que se aplicarán al servicio LocalWebservice.

deployment_config

LocalWebserviceDeploymentConfiguration

Requerido

Opciones de configuración de la implementación que se aplicarán al servicio LocalWebservice.

inference_config

InferenceConfig

Requerido

Objeto InferenceConfig que se usa para proporcionar las propiedades de implementación del modelo necesarias.

wait

bool

Requerido

Espera a que el contenedor del servicio alcance un estado correcto. (Valor predeterminado: False)

Tipo de valor devuelto

None

Excepciones

WebserviceException

update_deployment_state

Actualiza el estado actual del objeto en memoria.

Realiza una actualización local de las propiedades del objeto en función del estado actual del contenedor Docker local correspondiente.

update_deployment_state(must_exist=False)

Parámetros

must_exist

bool

valor predeterminado: False

Indica si el servicio web ya debe existir al crear el objeto en memoria.

Excepciones

WebserviceException

wait_for_deployment

Sondea la implementación de LocalWebservice en ejecución.

wait_for_deployment(show_output=False)

Parámetros

show_output

bool

Requerido

Opción para imprimir una salida más detallada. (Valor predeterminado: False)

Excepciones

WebserviceException

Atributos

port

Obtiene el puerto del servicio web local.

Devoluciones

Número de puerto.

Tipo de valor devuelto

int

scoring_uri

Obtiene el identificador URI de puntuación del servicio web local.

Devoluciones

Identificador URI de puntuación.

Tipo de valor devuelto

str

swagger_uri

Obtiene el identificador URI de Swagger del servicio web local.

Devoluciones

Identificador URI de Swagger.

Tipo de valor devuelto

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'