Esquema YAML de plantilla de implementación de la CLI (v2)

APPLIES TO:CLI de Azure ml extensión v2 (actual)

El esquema JSON de origen se puede encontrar en https://azuremlschemas.azureedge.net/latest/deploymentTemplate.schema.json.

Nota:

La sintaxis de YAML que se detalla en este documento se basa en el esquema JSON de la versión más reciente de la extensión ML de la CLI v2. Se garantiza que esta sintaxis solo funciona con la versión más reciente de la extensión ML de la CLI v2. Dispone de los esquemas de las versiones de anteriores de la extensión en https://azuremlschemasprod.azureedge.net/.

Sintaxis de YAML

Key Tipo Description Valores permitidos Valor predeterminado
$schema cuerda / cadena Esquema de YAML. Si usa la extensión de VS Code de Azure Machine Learning para crear el archivo YAML, incluida $schema en la parte superior del archivo le permite invocar finalizaciones de esquema y recursos.
name cuerda / cadena Obligatorio. Nombre de la plantilla de implementación.
version string o integer Versión de la plantilla de implementación.
description cuerda / cadena Descripción de la plantilla de implementación.
tags objeto Diccionario de etiquetas para la plantilla de implementación.
type cuerda / cadena Tipo de la plantilla de implementación.
deployment_template_type cuerda / cadena Obligatorio. Tipo de plantilla de implementación. "Administrado" es el único valor permitido actualmente.
environment cuerda / cadena Obligatorio. Entorno que se va a usar para la plantilla de implementación. Este valor debe ser una referencia a un entorno con versiones existente en un registro. Use la azureml://registries/<registry-name>/environments/<environment-name>/versions/<version> sintaxis .

Nota: Los entornos con ámbito de área de trabajo (con azureml:<name>:<version> sintaxis) y las definiciones de entorno insertadas no se admiten para las plantillas de implementación.
environment_variables objeto Diccionario de pares clave-valor de variable de entorno que se van a establecer para la implementación. Puede acceder a estas variables de entorno desde los scripts de puntuación.
instance_count entero Obligatorio. El número de instancias que se usarán para la implementación. Especifique el valor en función de la carga de trabajo que espera.
default_instance_type cuerda / cadena Obligatorio. Tipo de instancia predeterminado que se va a usar al implementar con esta plantilla.
allowed_instance_types cuerda / cadena Tipo de instancia permitido que se puede usar al implementar con esta plantilla.
model_mount_path cuerda / cadena Ruta de acceso para montar el modelo en el contenedor.
scoring_path cuerda / cadena Obligatorio. Ruta de acceso para el punto de conexión de puntuación.
scoring_port entero Obligatorio. Puerto del punto de conexión de puntuación.
liveness_probe objeto Configuración del sondeo de ejecución para supervisar el estado del contenedor con regularidad. Consulte ProbeSettings para ver el conjunto de propiedades configurables.
readiness_probe objeto Configuración de sondeo de preparación para validar si el contenedor está listo para atender el tráfico. Consulte ProbeSettings para ver el conjunto de propiedades configurables.
request_settings objeto Configuración de la solicitud para la implementación. Consulte RequestSettings para ver el conjunto de propiedades configurables.

ProbeSettings

Key Tipo Description Valor predeterminado
failure_threshold entero Cuando se produce un error en un sondeo, el sistema intenta failure_threshold tiempos antes de renunciar. Renunciar en el caso de un sondeo de ejecución significa que se reinicia el contenedor. En el caso de un sondeo de preparación, el contenedor se marca como No leído. El valor mínimo es 1. 30
initial_delay entero Número de segundos después de que se haya iniciado el contenedor antes de iniciar el sondeo. El valor mínimo es 1. 10
method cuerda / cadena Método HTTP que se va a usar para el sondeo.
path cuerda / cadena Ruta de acceso del sondeo.
period entero Frecuencia (en segundos) para realizar el sondeo. 10
port entero Puerto que se va a sondear.
scheme cuerda / cadena Esquema que se va a usar para el sondeo (por ejemplo, HTTP o HTTPS).
success_threshold entero El número mínimo de valores correctos consecutivos para que el sondeo se considere correcto después de que se haya producido un error. El valor mínimo es 1. 1
timeout entero Número de segundos después del cual se agota el tiempo de espera del sondeo. El valor mínimo es 1. 2

RequestSettings

Key Tipo Description Valor predeterminado
request_timeout_ms entero Tiempo de espera de la solicitud en milisegundos. 5000
max_concurrent_requests_per_instance entero Número máximo de solicitudes simultáneas por instancia permitidas para la implementación. 1

Observaciones

Las plantillas de implementación proporcionan una configuración reutilizable para implementar modelos. Definen el entorno, la configuración de infraestructura y las configuraciones de sondeo que se pueden aplicar al crear implementaciones.

Examples

A continuación se muestran ejemplos.

YAML: básico

$schema: https://azuremlschemas.azureedge.net/latest/deploymentTemplate.schema.json
name: my-deployment-template
version: 1
description: Basic deployment template example
deployment_template_type: Managed
environment: azureml://registries/my-registry/environments/my-environment/versions/1
instance_count: 1
default_instance_type: Standard_DS3_v2
scoring_path: /score
scoring_port: 5001

YAML: con variables de entorno y sondeos

$schema: https://azuremlschemas.azureedge.net/latest/deploymentTemplate.schema.json
name: my-deployment-template
version: 1
description: Deployment template with environment variables and health probes
deployment_template_type: Managed
environment: azureml://registries/azureml/environments/minimal-ubuntu20.04-py38-cpu-inference/versions/latest
environment_variables:
  MODEL_PATH: /var/azureml-app/model
  SCORING_TIMEOUT: "60"
instance_count: 3
default_instance_type: Standard_DS3_v2
scoring_path: /score
scoring_port: 8080
liveness_probe:
  initial_delay: 30
  period: 10
  timeout: 2
  success_threshold: 1
  failure_threshold: 3
readiness_probe:
  initial_delay: 10
  period: 5
  timeout: 2
  success_threshold: 1
  failure_threshold: 3
request_settings:
  request_timeout_ms: 10000
  max_concurrent_requests_per_instance: 2

YAML: con tipo de instancia permitido

$schema: https://azuremlschemas.azureedge.net/latest/deploymentTemplate.schema.json
name: my-deployment-template-restricted
version: 1
description: Deployment template with instance type restrictions
deployment_template_type: Managed
environment: azureml://registries/my-registry/environments/my-environment/versions/1
instance_count: 1
default_instance_type: Standard_DS3_v2
scoring_path: /score
scoring_port: 5001
allowed_instance_types: Standard_DS3_v2

YAML: con la ruta de montaje del modelo

$schema: https://azuremlschemas.azureedge.net/latest/deploymentTemplate.schema.json
name: my-deployment-template-custom-mount
version: 1
description: Deployment template with custom model mount path
deployment_template_type: Managed
environment: azureml://registries/my-registry/environments/my-environment/versions/1
instance_count: 1
default_instance_type: Standard_DS3_v2
scoring_path: /score
scoring_port: 5001
model_mount_path: /var/azureml-app/models

Pasos siguientes

  • Last updated on