AksEndpoint Clase

Nota

Se trata de una clase experimental y puede cambiar en cualquier momento. Consulte https://aka.ms/azuremlexperimental para más información.

Representa una colección de versiones del servicio web detrás del mismo punto de conexión que se ejecuta en Azure Kubernetes Service.

Mientras que AksWebservice implementa un único servicio con un único punto de conexión de puntuación, la clase AksEndpoint permite implementar varias versiones del servicio web detrás del mismo punto de conexión de puntuación. Cada versión del servicio web se puede configurar para atender un porcentaje del tráfico para que pueda implementar modelos de forma controlada, por ejemplo, para las pruebas A/B. AksEndpoint permite la implementación desde un objeto de modelo similar a AksWebservice.

Inicialice la instancia del servicio web.

El constructor webservice recupera una representación en la nube de un objeto Webservice asociado al área de trabajo proporcionada. Devolverá una instancia de una clase secundaria correspondiente al tipo específico del objeto Webservice recuperado.

Herencia

AksWebservice

AksEndpoint

Constructor

AksEndpoint(workspace, name)

Parámetros

Nombre	Description
workspace Requerido	Workspace Objeto Workspace que contiene el objeto Webservice que se va a recuperar.
name Requerido	str Nombre del objeto Webservice que se va a recuperar.

Variables

Nombre	Description
versions	dict[str, AksWebservice] Diccionario de nombre de versión para el objeto de versión. Contiene todas las versiones implementadas como parte de este punto de conexión.

Métodos

create_version	Agrega una nueva versión en un punto de conexión con las propiedades proporcionadas.
delete_version	Elimine una versión de un punto de conexión.
deploy_configuration	Crea un objeto de configuración para la implementación en un destino de proceso de AKS.
serialize	Convierte este servicio web en un diccionario JSON serializado.
update	Actualiza el punto de conexión con las propiedades proporcionadas. Los valores que se dejan como Ninguno permanecerán sin cambios en este punto de conexión.
update_version	Actualiza una versión existente en un punto de conexión con las propiedades proporcionadas. Los valores que se dejan como Ninguno permanecerán sin cambios en esta versión.

create_version

Agrega una nueva versión en un punto de conexión con las propiedades proporcionadas.

create_version(version_name, autoscale_enabled=None, autoscale_min_replicas=None, autoscale_max_replicas=None, autoscale_refresh_seconds=None, autoscale_target_utilization=None, collect_model_data=None, cpu_cores=None, memory_gb=None, scoring_timeout_ms=None, replica_max_concurrent_requests=None, max_request_wait_time=None, num_replicas=None, tags=None, properties=None, description=None, models=None, inference_config=None, gpu_cores=None, period_seconds=None, initial_delay_seconds=None, timeout_seconds=None, success_threshold=None, failure_threshold=None, traffic_percentile=None, is_default=None, is_control_version_type=None, cpu_cores_limit=None, memory_gb_limit=None)

Parámetros

Nombre	Description
version_name Requerido	str Nombre de la versión que se va a agregar en un punto de conexión.
autoscale_enabled	bool Indica si se habilita o no el escalado automático para esta versión en un punto de conexión. El valor predeterminado es True si num_replicas es Ninguno. Valor predeterminado: None
autoscale_min_replicas	int Número mínimo de contenedores que se van a usar al escalar automáticamente esta versión en un punto de conexión. El valor predeterminado es 1. Valor predeterminado: None
autoscale_max_replicas	int Número máximo de contenedores que se van a usar al escalar automáticamente esta versión en un punto de conexión. El valor predeterminado es 10. Valor predeterminado: None
autoscale_refresh_seconds	int Frecuencia con la que el escalador automático debe intentar escalar esta versión en un punto de conexión. El valor predeterminado es 1. Valor predeterminado: None
autoscale_target_utilization	int Uso objetivo (en un porcentaje de 100) que el escalador automático debe intentar mantener para esta versión en un punto de conexión. El valor predeterminado es 70. Valor predeterminado: None
collect_model_data	bool Indica si se habilita o no la recopilación de datos del modelo para esta versión en un punto de conexión. El valor predeterminado es False. Valor predeterminado: None
cpu_cores	float Número de núcleos de CPU que se asignarán para esta versión en un punto de conexión. Puede ser un decimal. El valor predeterminado es 0,1. Valor predeterminado: None
memory_gb	float Cantidad de memoria (en GB) que se va a asignar para esta versión en un punto de conexión. Puede ser un decimal. El valor predeterminado es 0,5. Valor predeterminado: None
scoring_timeout_ms	int Tiempo de espera que se aplica para puntuar las llamadas a esta versión en un punto de conexión. El valor predeterminado es 60 000. Valor predeterminado: None
replica_max_concurrent_requests	int Número máximo de solicitudes simultáneas por réplica que se permitirán para esta versión en un punto de conexión. De manera predeterminada, su valor es 1. No cambie este valor a menos que se lo indique el soporte técnico de Microsoft o un miembro del equipo de Azure Machine Learning. Valor predeterminado: None
max_request_wait_time	int Cantidad máxima de tiempo que permanecerá una solicitud en la cola (en milisegundos) antes de devolver un error 503. El valor predeterminado es 500. Valor predeterminado: None
num_replicas	int Número de contenedores que se asignarán para esta versión en un punto de conexión. No tiene un valor predeterminado. Si no se establece este parámetro, el escalador automático se habilita de manera predeterminada. Valor predeterminado: None
tags	dict[str, str] Diccionario de etiquetas de clave-valor que se va a proporcionar a este punto de conexión. Valor predeterminado: None
properties	dict[str, str] Diccionario de propiedades de clave-valor que se va a proporcionar a este punto de conexión. Estas propiedades no se pueden cambiar después de la implementación, pero se pueden agregar nuevos pares clave-valor. Valor predeterminado: None
description	str Descripción que se va a proporcionar a este punto de conexión. Valor predeterminado: None
models	list[Model] Lista de objetos de modelo que se van a empaquetar con el servicio actualizado. Valor predeterminado: None
inference_config	InferenceConfig Objeto InferenceConfig que se usa para proporcionar las propiedades de implementación del modelo necesarias. Valor predeterminado: None
gpu_cores	int Número de núcleos de GPU que se asignarán para esta versión en un punto de conexión. El valor predeterminado es 0. Valor predeterminado: None
period_seconds	int Frecuencia (en segundos) en que se ejecutará el sondeo de ejecución. El valor predeterminado es de 10 segundos. El valor mínimo es 1. Valor predeterminado: None
initial_delay_seconds	int Número de segundos después de que se haya iniciado el contenedor antes de que se inicien los sondeos de ejecución. El valor predeterminado es 310. Valor predeterminado: None
timeout_seconds	int Número de segundos tras los cuales el sondeo de ejecución agota el tiempo de espera. El valor predeterminado es de 2 segundos. El valor mínimo es 1. Valor predeterminado: None
success_threshold	int Número mínimo de valores correctos consecutivos para que el sondeo de ejecución se considere correcto después de que se haya producido un error. De manera predeterminada, su valor es 1. El valor mínimo es 1. Valor predeterminado: None
failure_threshold	int Cuando se inicie un pod y se produzca un error en el sondeo de ejecución, Kubernetes probará las veces especificadas en failureThreshold antes de abandonarlo. El valor predeterminado es 3. El valor mínimo es 1. Valor predeterminado: None
traffic_percentile	float Cantidad de tráfico que toma la versión en un punto de conexión. Valor predeterminado: None
is_default	bool Indica si se debe convertir o no esta versión como versión predeterminada en un punto de conexión. El valor predeterminado es False. Valor predeterminado: None
is_control_version_type	bool Indica si se debe convertir o no esta versión como versión de control en un punto de conexión. El valor predeterminado es False. Valor predeterminado: None
cpu_cores_limit	float Número máximo de núcleos de CPU que puede usar este servicio web. Puede ser un decimal. Valor predeterminado: None
memory_gb_limit	float Cantidad máxima de memoria (en GB) que puede usar este objeto Webservice. Puede ser un decimal. Valor predeterminado: None

Excepciones

Tipo	Description
WebserviceException

delete_version

Elimine una versión de un punto de conexión.

delete_version(version_name)

Parámetros

Nombre	Description
version_name Requerido	str Nombre de la versión de un punto de conexión que se va a eliminar.

Excepciones

Tipo	Description
WebserviceException

deploy_configuration

Crea un objeto de configuración para la implementación en un destino de proceso de AKS.

static deploy_configuration(autoscale_enabled=None, autoscale_min_replicas=None, autoscale_max_replicas=None, autoscale_refresh_seconds=None, autoscale_target_utilization=None, collect_model_data=None, auth_enabled=None, cpu_cores=None, memory_gb=None, enable_app_insights=None, scoring_timeout_ms=None, replica_max_concurrent_requests=None, max_request_wait_time=None, num_replicas=None, primary_key=None, secondary_key=None, tags=None, properties=None, description=None, gpu_cores=None, period_seconds=None, initial_delay_seconds=None, timeout_seconds=None, success_threshold=None, failure_threshold=None, namespace=None, token_auth_enabled=None, version_name=None, traffic_percentile=None, compute_target_name=None, cpu_cores_limit=None, memory_gb_limit=None)

Parámetros

Nombre	Description
autoscale_enabled	bool Indica si se habilita o no el escalado automático para esta versión en un punto de conexión. El valor predeterminado es True si num_replicas es Ninguno. Valor predeterminado: None
autoscale_min_replicas	int Número mínimo de contenedores que se van a usar al escalar automáticamente esta versión en un punto de conexión. De manera predeterminada, su valor es 1. Valor predeterminado: None
autoscale_max_replicas	int Número máximo de contenedores que se van a usar al escalar automáticamente esta versión en un punto de conexión. El valor predeterminado es 10. Valor predeterminado: None
autoscale_refresh_seconds	int Frecuencia con la que el escalador automático debe intentar escalar esta versión en un punto de conexión. De manera predeterminada, su valor es 1. Valor predeterminado: None
autoscale_target_utilization	int Uso objetivo (en un porcentaje de 100) que el escalador automático debe intentar mantener para esta versión en un punto de conexión. El valor predeterminado es 70. Valor predeterminado: None
collect_model_data	bool Indica si se habilita o no la recopilación de datos del modelo para esta versión en un punto de conexión. El valor predeterminado es False. Valor predeterminado: None
auth_enabled	bool Indica si se habilita o no la autenticación de clave para esta versión en un punto de conexión. El valor predeterminado es True. Valor predeterminado: None
cpu_cores	float Número de núcleos de CPU que se asignarán para esta versión en un punto de conexión. Puede ser un decimal. El valor predeterminado es 0,1. Valor predeterminado: None
memory_gb	float Cantidad de memoria (en GB) que se va a asignar para esta versión en un punto de conexión. Puede ser un decimal. El valor predeterminado es 0,5. Valor predeterminado: None
enable_app_insights	bool Indica si se habilita o no el registro de Application Insights para esta versión en un punto de conexión. El valor predeterminado es False. Valor predeterminado: None
scoring_timeout_ms	int Tiempo de espera que se aplica para puntuar las llamadas a esta versión en un punto de conexión. El valor predeterminado es 60 000. Valor predeterminado: None
replica_max_concurrent_requests	int Número máximo de solicitudes simultáneas por réplica que se permitirán para esta versión en un punto de conexión. De manera predeterminada, su valor es 1. No cambie este valor a menos que se lo indique el soporte técnico de Microsoft o un miembro del equipo de Azure Machine Learning. Valor predeterminado: None
max_request_wait_time	int Cantidad máxima de tiempo que permanecerá una solicitud en la cola (en milisegundos) antes de devolver un error 503. El valor predeterminado es 500. Valor predeterminado: None
num_replicas	int Número de contenedores que se asignarán para esta versión en un punto de conexión. No tiene un valor predeterminado. Si no se establece este parámetro, el escalador automático se habilita de manera predeterminada. Valor predeterminado: None
primary_key	str Clave de autenticación principal que se usará para este punto de conexión. Valor predeterminado: None
secondary_key	str Clave de autenticación secundaria que se usará para este punto de conexión. Valor predeterminado: None
tags	dict[str, str] Diccionario de etiquetas de clave-valor que se va a proporcionar a este punto de conexión. Valor predeterminado: None
properties	dict[str, str] Diccionario de propiedades de clave-valor que se va a proporcionar a este punto de conexión. Estas propiedades no se pueden cambiar después de la implementación, pero se pueden agregar nuevos pares clave-valor. Valor predeterminado: None
description	str Descripción que se va a proporcionar a este punto de conexión. Valor predeterminado: None
gpu_cores	int Número de núcleos de GPU que se asignarán para esta versión en un punto de conexión. El valor predeterminado es 0. Valor predeterminado: None
period_seconds	int Frecuencia (en segundos) en que se ejecutará el sondeo de ejecución. El valor predeterminado es de 10 segundos. El valor mínimo es 1. Valor predeterminado: None
initial_delay_seconds	int Número de segundos después de que se haya iniciado el contenedor antes de que se inicien los sondeos de ejecución. El valor predeterminado es 310. Valor predeterminado: None
timeout_seconds	int Número de segundos tras los cuales el sondeo de ejecución agota el tiempo de espera. El valor predeterminado es de 2 segundos. El valor mínimo es 1. Valor predeterminado: None
success_threshold	int Número mínimo de valores correctos consecutivos para que el sondeo de ejecución se considere correcto después de que se haya producido un error. De manera predeterminada, su valor es 1. El valor mínimo es 1. Valor predeterminado: None
failure_threshold	int Cuando se inicie un pod y se produzca un error en el sondeo de ejecución, Kubernetes probará failureThreshold veces antes de abandonar. El valor predeterminado es 3. El valor mínimo es 1. Valor predeterminado: None
namespace	str Espacio de nombres de Kubernetes en el que se va a implementar este punto de conexión: hasta 63 caracteres alfanuméricos en minúsculas ("a"-"z", "0"-"9") y guion ("-"). El primer y el último carácter no puede ser un guion. Valor predeterminado: None
token_auth_enabled	bool Indica si se debe habilitar o no la autenticación de token para este punto de conexión. Si esta opción está habilitada, los usuarios pueden acceder a este punto de conexión mediante la recuperación de un token de acceso con sus credenciales de Azure Active Directory. El valor predeterminado es False. Valor predeterminado: None
version_name	str Nombre de la versión de un punto de conexión. Valor predeterminado: None
traffic_percentile	float Cantidad de tráfico que toma la versión en un punto de conexión. Valor predeterminado: None
compute_target_name	str Nombre del destino de proceso en el que se implementará. Valor predeterminado: None
cpu_cores_limit	float Número máximo de núcleos de CPU que puede usar este servicio web. Puede ser un decimal. Valor predeterminado: None
memory_gb_limit	float Cantidad máxima de memoria (en GB) que puede usar este objeto Webservice. Puede ser un decimal. Valor predeterminado: None

Devoluciones

Tipo	Description
AksEndpointDeploymentConfiguration

Excepciones

Tipo	Description
WebserviceException

serialize

Convierte este servicio web en un diccionario JSON serializado.

serialize()

Devoluciones

Tipo	Description
dict	Representación JSON de este servicio web.

Excepciones

Tipo	Description
WebserviceException

update

Actualiza el punto de conexión con las propiedades proporcionadas.

Los valores que se dejan como Ninguno permanecerán sin cambios en este punto de conexión.

update(auth_enabled=None, token_auth_enabled=None, enable_app_insights=None, description=None, tags=None, properties=None)

Parámetros

Nombre	Description
auth_enabled	bool Indica si se habilita o no la autenticación de clave para esta versión en un punto de conexión. El valor predeterminado es True. Valor predeterminado: None
token_auth_enabled	bool Indica si se debe habilitar o no la autenticación de token para este punto de conexión. Si esta opción está habilitada, los usuarios pueden acceder a este punto de conexión mediante la recuperación de un token de acceso con sus credenciales de Azure Active Directory. El valor predeterminado es False. Valor predeterminado: None
enable_app_insights	bool Indica si se habilita o no el registro de Application Insights para esta versión en un punto de conexión. El valor predeterminado es False. Valor predeterminado: None
description	str Descripción que se va a proporcionar a este punto de conexión. Valor predeterminado: None
tags	dict[str, str] Diccionario de etiquetas de clave-valor que se va a proporcionar a este punto de conexión. Valor predeterminado: None
properties	dict[str, str] Diccionario de propiedades de clave-valor que se va a proporcionar a este punto de conexión. Estas propiedades no se pueden cambiar después de la implementación, pero se pueden agregar nuevos pares clave-valor. Valor predeterminado: None

Excepciones

Tipo	Description
WebserviceException

update_version

Actualiza una versión existente en un punto de conexión con las propiedades proporcionadas.

Los valores que se dejan como Ninguno permanecerán sin cambios en esta versión.

update_version(version_name, autoscale_enabled=None, autoscale_min_replicas=None, autoscale_max_replicas=None, autoscale_refresh_seconds=None, autoscale_target_utilization=None, collect_model_data=None, cpu_cores=None, memory_gb=None, scoring_timeout_ms=None, replica_max_concurrent_requests=None, max_request_wait_time=None, num_replicas=None, tags=None, properties=None, description=None, models=None, inference_config=None, gpu_cores=None, period_seconds=None, initial_delay_seconds=None, timeout_seconds=None, success_threshold=None, failure_threshold=None, traffic_percentile=None, is_default=None, is_control_version_type=None, cpu_cores_limit=None, memory_gb_limit=None)

Parámetros

Nombre	Description
version_name Requerido	str Nombre de la versión de un punto de conexión.
autoscale_enabled	bool Indica si se habilita o no el escalado automático para esta versión en un punto de conexión. El valor predeterminado es True si num_replicas es Ninguno. Valor predeterminado: None
autoscale_min_replicas	int Número mínimo de contenedores que se van a usar al escalar automáticamente esta versión en un punto de conexión. De manera predeterminada, su valor es 1. Valor predeterminado: None
autoscale_max_replicas	int Número máximo de contenedores que se van a usar al escalar automáticamente esta versión en un punto de conexión. El valor predeterminado es 10. Valor predeterminado: None
autoscale_refresh_seconds	int Frecuencia con la que el escalador automático debe intentar escalar esta versión en un punto de conexión. El valor predeterminado es 1. Valor predeterminado: None
autoscale_target_utilization	int Uso objetivo (en un porcentaje de 100) que el escalador automático debe intentar mantener para esta versión en un punto de conexión. El valor predeterminado es 70. Valor predeterminado: None
collect_model_data	bool Indica si se habilita o no la recopilación de datos del modelo para esta versión en un punto de conexión. El valor predeterminado es False. Valor predeterminado: None
cpu_cores	float Número de núcleos de CPU que se asignarán para esta versión en un punto de conexión. Puede ser un decimal. El valor predeterminado es 0,1. Valor predeterminado: None
memory_gb	float Cantidad de memoria (en GB) que se va a asignar para esta versión en un punto de conexión. Puede ser un decimal. El valor predeterminado es 0,5. Valor predeterminado: None
scoring_timeout_ms	int Tiempo de espera que se aplica para puntuar las llamadas a esta versión en un punto de conexión. El valor predeterminado es 60 000. Valor predeterminado: None
replica_max_concurrent_requests	int Número máximo de solicitudes simultáneas por réplica que se permitirán para esta versión en un punto de conexión. De manera predeterminada, su valor es 1. No cambie este valor a menos que se lo indique el soporte técnico de Microsoft o un miembro del equipo de Azure Machine Learning. Valor predeterminado: None
max_request_wait_time	int Cantidad máxima de tiempo que permanecerá una solicitud en la cola (en milisegundos) antes de devolver un error 503. El valor predeterminado es 500. Valor predeterminado: None
num_replicas	int Número de contenedores que se asignarán para esta versión en un punto de conexión. No tiene un valor predeterminado. Si no se establece este parámetro, el escalador automático se habilita de manera predeterminada. Valor predeterminado: None
tags	dict[str, str] Diccionario de etiquetas de clave-valor que se va a proporcionar a este punto de conexión. Valor predeterminado: None
properties	dict[str, str] Diccionario de propiedades de clave-valor que se va a proporcionar a este punto de conexión. Estas propiedades no se pueden cambiar después de la implementación, pero se pueden agregar nuevos pares clave-valor. Valor predeterminado: None
description	str Descripción que se va a proporcionar a este punto de conexión. Valor predeterminado: None
models	list[Model] Lista de objetos de modelo que se van a empaquetar con el servicio actualizado. Valor predeterminado: None
inference_config	InferenceConfig Objeto InferenceConfig que se usa para proporcionar las propiedades de implementación del modelo necesarias. Valor predeterminado: None
gpu_cores	int Número de núcleos de GPU que se asignarán para esta versión en un punto de conexión. El valor predeterminado es 0. Valor predeterminado: None
period_seconds	int Frecuencia (en segundos) en que se ejecutará el sondeo de ejecución. El valor predeterminado es de 10 segundos. El valor mínimo es 1. Valor predeterminado: None
initial_delay_seconds	int Número de segundos después de que se haya iniciado el contenedor antes de que se inicien los sondeos de ejecución. El valor predeterminado es 310. Valor predeterminado: None
timeout_seconds	int Número de segundos tras los cuales el sondeo de ejecución agota el tiempo de espera. El valor predeterminado es de 2 segundos. El valor mínimo es 1. Valor predeterminado: None
success_threshold	int Número mínimo de valores correctos consecutivos para que el sondeo de ejecución se considere correcto después de que se haya producido un error. De manera predeterminada, su valor es 1. El valor mínimo es 1. Valor predeterminado: None
failure_threshold	int Cuando se inicie un pod y se produzca un error en el sondeo de ejecución, Kubernetes probará las veces especificadas en failureThreshold antes de abandonarlo. El valor predeterminado es 3. El valor mínimo es 1. Valor predeterminado: None
traffic_percentile	float Cantidad de tráfico que toma la versión en un punto de conexión. Valor predeterminado: None
is_default	bool Indica si se debe convertir o no esta versión como versión predeterminada en un punto de conexión. El valor predeterminado es False. Valor predeterminado: None
is_control_version_type	bool Indica si se debe convertir o no esta versión como versión de control en un punto de conexión. El valor predeterminado es False. Valor predeterminado: None
cpu_cores_limit	float Número máximo de núcleos de CPU que puede usar este servicio web. Puede ser un decimal. Valor predeterminado: None
memory_gb_limit	float Cantidad máxima de memoria (en GB) que puede usar este objeto Webservice. Puede ser un decimal. Valor predeterminado: None

Excepciones

Tipo	Description
WebserviceException