Compartir a través de

LocalWebservice Clase

  • Referencia

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

Nombre Description
workspace
Requerido
Workspace

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

Nombre del objeto Webservice que se va a recuperar.
must_exist
Requerido
bool

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

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

Nombre del objeto LocalWebservice que se va a recuperar.
must_exist
Requerido
bool

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

Nombre Description
delete_cache
Requerido
bool

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

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

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

Excepciones

Tipo Description
WebserviceException

deploy_configuration

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

static deploy_configuration(port=None)

Parámetros

Nombre Description
port
int

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

Valor predeterminado: None

Devoluciones

Tipo Description
LocalWebserviceDeploymentConfiguration

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

Excepciones

Tipo Description
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

Nombre Description
name
str

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

Valor predeterminado: None
deployment_config
WebserviceDeploymentConfiguration

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.

Valor predeterminado: None
deployment_target
ComputeTarget

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.

Valor predeterminado: None

Devoluciones

Tipo Description
Webservice

Objeto Webservice correspondiente al servicio web implementado.

Excepciones

Tipo Description
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

Nombre Description
cls
Requerido
workspace
Requerido
Workspace

Objeto Workspace en el que está registrado el objeto Webservice.
webservice_payload
Requerido
dict

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

Excepciones

Tipo Description
azureml.exceptions.NotImplementedError

get_keys

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

Nota

No se admite para LocalWebservice.

get_keys()

Devoluciones

Tipo Description

Claves de autenticación para este objeto Webservice.

Excepciones

Tipo Description
azureml.exceptions.NotImplementedError

get_logs

Recupera los registros de este servicio LocalWebservice.

get_logs(num_lines=5000, raw=False)

Parámetros

Nombre Description
num_lines
Requerido
int

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

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

Devoluciones

Tipo Description
str

Registros de este servicio LocalWebservice.

Excepciones

Tipo Description
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

Tipo Description
str, datetime

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

Excepciones

Tipo Description
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

Nombre Description
workspace
Requerido
Workspace

Objeto Workspace asociado a LocalWebservices.
model_name
str

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

Valor predeterminado: None
model_id
str

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

Valor predeterminado: None
all
bool

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

Valor predeterminado: None

Devoluciones

Tipo Description
list[LocalWebservice]

Lista filtrada de objetos LocalWebservices asociada al objeto Workspace proporcionado.

Excepciones

Tipo Description
WebserviceException

regen_key

Vuelve a generar una de las claves del objeto Webservice.

Nota

No se admite para LocalWebservice.

regen_key(key)

Parámetros

Nombre Description
key
Requerido
str

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

Excepciones

Tipo Description
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

Nombre Description
wait
Requerido
bool

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

Excepciones

Tipo Description
WebserviceException

run

Llama a este servicio LocalWebservice con la entrada proporcionada.

run(input_data)

Parámetros

Nombre Description
input_data
Requerido
<xref:varies>

Entrada con la que se va a llamar a LocalWebservice.

Devoluciones

Tipo Description
<xref:varies>

Resultado de llamar a LocalWebservice.

Excepciones

Tipo Description
WebserviceException

serialize

Convierte este objeto Webservice en un diccionario serializado JSON.

serialize()

Devoluciones

Tipo Description
dict

Representación serializada del objeto Webservice.

Excepciones

Tipo Description
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

Nombre Description
models
Requerido
list[Model]

Nueva lista de modelos contenidos en LocalWebservice.
image_config
Requerido
ContainerImageConfig

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

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

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

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

Devoluciones

Tipo Description
None

Excepciones

Tipo Description
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

Nombre Description
must_exist
bool

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

Valor predeterminado: False

Excepciones

Tipo Description
WebserviceException

wait_for_deployment

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

wait_for_deployment(show_output=False)

Parámetros

Nombre Description
show_output
Requerido
bool

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

Excepciones

Tipo Description
WebserviceException

Atributos

port

Obtiene el puerto del servicio web local.

Devoluciones

Tipo Description
int

Número de puerto.

scoring_uri

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

Devoluciones

Tipo Description
str

Identificador URI de puntuación.

swagger_uri

Obtiene el identificador URI de Swagger del servicio web local.

Devoluciones

Tipo Description
str

Identificador URI de Swagger.

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'