YAML-schema voor CLI -implementatiesjabloon (v2)

TOEPASSELIJK OP:Azure CLI ml-extensie v2 (huidige)

Het JSON-bronschema vindt u op https://azuremlschemas.azureedge.net/latest/deploymentTemplate.schema.json.

Note

De YAML-syntaxis die in dit document wordt beschreven, is gebaseerd op het JSON-schema voor de nieuwste versie van de ML CLI v2-extensie. Deze syntaxis werkt gegarandeerd alleen met de nieuwste versie van de ML CLI v2-extensie. U vindt de schema's voor oudere extensieversies op https://azuremlschemasprod.azureedge.net/.

YAML syntax

Key Type Description Allowed values Default value
$schema string Het YAML-schema. Als u de extensie Azure Machine Learning VS Code gebruikt om het YAML-bestand te maken, inclusief $schema boven aan het bestand, kunt u schema- en resourcevoltooiingen aanroepen.
name string Required. Naam van de implementatiesjabloon.
version tekenreeks of geheel getal Versie van de implementatiesjabloon.
description string Beschrijving van de implementatiesjabloon.
tags object Woordenlijst met tags voor de implementatiesjabloon.
type string Type van de implementatiesjabloon.
deployment_template_type string Required. Het type implementatiesjabloon. 'Beheerd' is de enige toegestane waarde.
environment string Required. De omgeving die moet worden gebruikt voor de implementatiesjabloon. Deze waarde moet een verwijzing naar een bestaande versieomgeving in een register zijn. Gebruik de azureml://registries/<registry-name>/environments/<environment-name>/versions/<version> syntaxis.

Opmerking: Omgevingen met werkruimtebereik (met syntaxis azureml:<name>:<version> ) en inlineomgevingsdefinities worden niet ondersteund voor implementatiesjablonen.
environment_variables object Woordenlijst van sleutel-waardeparen van omgevingsvariabelen die moeten worden ingesteld voor de implementatie. U kunt deze omgevingsvariabelen openen vanuit uw scorescripts.
instance_count integer Required. Het aantal exemplaren dat moet worden gebruikt voor de implementatie. Geef de waarde op op basis van de workload die u verwacht.
default_instance_type string Required. Het standaardexemplarentype dat moet worden gebruikt bij het implementeren met deze sjabloon.
allowed_instance_types string Het toegestane exemplaartype dat kan worden gebruikt bij het implementeren met deze sjabloon.
model_mount_path string Het pad om het model in de container te koppelen.
scoring_path string Required. Het pad voor het score-eindpunt.
scoring_port integer Required. De poort voor het score-eindpunt.
liveness_probe object Instellingen voor livenesstest voor het regelmatig controleren van de status van de container. Zie ProbeSettings voor de set configureerbare eigenschappen.
readiness_probe object Instellingen voor gereedheidstests om te valideren of de container gereed is om verkeer te verwerken. Zie ProbeSettings voor de set configureerbare eigenschappen.
request_settings object Aanvraaginstellingen voor de implementatie. Zie RequestSettings voor de set configureerbare eigenschappen.

ProbeSettings

Key Type Description Default value
failure_threshold integer Wanneer een test mislukt, probeert failure_threshold het systeem tijden voordat het opgeeft. Het opgeven in het geval van een livenesstest betekent dat de container opnieuw wordt opgestart. In het geval van een gereedheidstest wordt de container gemarkeerd als Ongelezen. Minimumwaarde is 1. 30
initial_delay integer Het aantal seconden nadat de container is gestart voordat de test wordt gestart. Minimumwaarde is 1. 10
method string De HTTP-methode die moet worden gebruikt voor de test.
path string Het pad voor de test.
period integer Hoe vaak (in seconden) de test moet worden uitgevoerd. 10
port integer De poort die moet worden uitgevoerd.
scheme string Het schema dat moet worden gebruikt voor de test (bijvoorbeeld HTTP of HTTPS).
success_threshold integer Het minimum aantal opeenvolgende successen dat nodig is zodat de proef als geslaagd wordt beschouwd nadat deze is mislukt. Minimumwaarde is 1. 1
timeout integer Het aantal seconden waarna er een time-out optreedt voor de test. Minimumwaarde is 1. 2

RequestSettings

Key Type Description Default value
request_timeout_ms integer De time-out van de aanvraag in milliseconden. 5000
max_concurrent_requests_per_instance integer Het maximum aantal gelijktijdige aanvragen per exemplaar dat is toegestaan voor de implementatie. 1

Remarks

Implementatiesjablonen bieden een herbruikbare configuratie voor het implementeren van modellen. Ze definiëren de omgeving, infrastructuurinstellingen en testconfiguraties die kunnen worden toegepast bij het maken van implementaties.

Examples

Hieronder ziet u voorbeelden.

YAML: basic

$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: met omgevingsvariabelen en tests

$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: met toegestaan exemplaartype

$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: met pad voor modelkoppeling

$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

Next steps

  • Last updated on