Schemat YAML szablonu wdrożenia interfejsu wiersza polecenia (wersja 2)

DOTYCZY:Rozszerzenie ML dla interfejsu wiersza poleceń Azure CLI wersja 2 (aktualna)

Źródłowy schemat JSON można znaleźć pod adresem https://azuremlschemas.azureedge.net/latest/deploymentTemplate.schema.json.

Uwaga / Notatka

Składnia YAML szczegółowo w tym dokumencie jest oparta na schemacie JSON dla najnowszej wersji rozszerzenia interfejsu wiersza polecenia uczenia maszynowego w wersji 2. Ta składnia jest gwarantowana tylko do pracy z najnowszą wersją rozszerzenia interfejsu wiersza polecenia uczenia maszynowego w wersji 2. Schematy dla starszych wersji rozszerzeń można znaleźć pod adresem https://azuremlschemasprod.azureedge.net/.

Składnia YAML

Key Typ Opis Dozwolone wartości Wartość domyślna
$schema ciąg Schemat YAML. Jeśli używasz rozszerzenia Azure Machine Learning VS Code do tworzenia pliku YAML, w tym $schema w górnej części pliku, umożliwia wywoływanie uzupełniania schematu i zasobów.
name ciąg Required. Nazwa szablonu wdrożenia.
version ciąg lub liczba całkowita Wersja szablonu wdrożenia.
description ciąg Opis szablonu wdrożenia.
display_name ciąg Nazwa wyświetlana szablonu wdrożenia. Używane przez powierzchnie interfejsu użytkownika (takie jak portal Foundry) do prezentowania przyjaznej etykiety użytkownikom podczas wybierania szablonu wdrożenia.
tags obiekt Słownik tagów szablonu wdrożenia.
type ciąg Typ szablonu wdrożenia.
deployment_template_type ciąg Required. Typ szablonu wdrożenia. Wartość "Zarządzana" jest jedyną dozwoloną wartością.
environment ciąg Required. Środowisko do użycia dla szablonu wdrożenia. Ta wartość musi być odwołaniem do istniejącego środowiska w wersji w rejestrze. azureml://registries/<registry-name>/environments/<environment-name>/versions/<version> Użyj składni.

Uwaga: Środowiska o zakresie obszaru roboczego (przy użyciu azureml:<name>:<version> składni) i wbudowane definicje środowiska nie są obsługiwane w przypadku szablonów wdrażania.
environment_variables obiekt Słownik par klucz-wartość zmiennej środowiskowej do ustawienia dla wdrożenia. Dostęp do tych zmiennych środowiskowych można uzyskać za pomocą skryptów oceniania.
instance_count liczba całkowita Required. Liczba wystąpień do użycia na potrzeby wdrożenia. Określ wartość na podstawie oczekiwanego obciążenia.
default_instance_type ciąg Required. Domyślny typ wystąpienia do użycia podczas wdrażania za pomocą tego szablonu.
allowed_instance_types lista ciągów Typy wystąpień, które użytkownicy mogą ustawić podczas wdrażania modelu korzystającego z tego szablonu. Określ typy wystąpień jako listę ciągów.
model_mount_path ciąg Ścieżka do zainstalowania modelu w kontenerze.
scoring_path ciąg Required. Ścieżka punktu końcowego oceniania.
scoring_port liczba całkowita Required. Port punktu końcowego oceniania.
liveness_probe obiekt Ustawienia sondy liveness do regularnego monitorowania kondycji kontenera. Zobacz ProbeSettings , aby uzyskać zestaw konfigurowalnych właściwości.
readiness_probe obiekt Ustawienia sondy gotowości do sprawdzania poprawności, czy kontener jest gotowy do obsługi ruchu. Zobacz ProbeSettings , aby uzyskać zestaw konfigurowalnych właściwości.
request_settings obiekt Zażądaj ustawień wdrożenia. Zobacz RequestSettings , aby uzyskać zestaw konfigurowalnych właściwości.

ProbeSettings

Key Typ Opis Wartość domyślna
failure_threshold liczba całkowita Gdy sonda zakończy się niepowodzeniem, system spróbuje failure_threshold kilka razy przed rezygnacją. Rezygnacja w przypadku sondy aktualności oznacza ponowne uruchomienie kontenera. W przypadku sondy gotowości kontener jest oznaczony jako Nieprzeczytany. Wartość minimalna to 1. 30
initial_delay liczba całkowita Liczba sekund po uruchomieniu kontenera przed zainicjowaniem sondy. Wartość minimalna to 1. 10
method ciąg Metoda HTTP do użycia dla sondy.
path ciąg Ścieżka sondy.
period liczba całkowita Jak często (w sekundach) wykonać sondę. 10
port liczba całkowita Port do sondowania.
scheme ciąg Schemat do użycia dla sondy (na przykład HTTP lub HTTPS).
success_threshold liczba całkowita Minimalna liczba kolejnych sukcesów dla sondy, która ma zostać uznana za pomyślną po niepodaniu. Wartość minimalna to 1. 1
timeout liczba całkowita Liczba sekund, po których sonda upłynął limit czasu. Wartość minimalna to 1. 2

RequestSettings

Key Typ Opis Wartość domyślna
request_timeout_ms liczba całkowita Limit czasu żądania w milisekundach. 5000
max_concurrent_requests_per_instance liczba całkowita Maksymalna liczba współbieżnych żądań na wystąpienie dozwolone dla wdrożenia. 1

Remarks

Szablony wdrażania zapewniają konfigurację wielokrotnego użytku na potrzeby wdrażania modeli. Definiują one środowisko, ustawienia infrastruktury i konfiguracje sond, które można zastosować podczas tworzenia wdrożeń.

Przykłady

Poniżej przedstawiono przykłady.

YAML: podstawowy

$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: ze zmiennymi środowiskowymi i sondami

$schema: https://azuremlschemas.azureedge.net/latest/deploymentTemplate.schema.json
name: my-deployment-template
version: 1
description: Deployment template with environment variables and health probes
display_name: My deployment template
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: z dozwolonymi typami wystąpień

$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
allowed_instance_types:
  - Standard_DS3_v2
  - Standard_DS4_v2
scoring_path: /score
scoring_port: 5001

YAML: z dozwolonymi typami wystąpień (lista)

$schema: https://azuremlschemas.azureedge.net/latest/deploymentTemplate.schema.json
name: my-deployment-template-multi
version: 1
description: Deployment template that allows multiple instance types
deployment_template_type: Managed
environment: azureml://registries/my-registry/environments/my-environment/versions/1
instance_count: 1
default_instance_type: Standard_DS3_v2
allowed_instance_types:
  - Standard_DS3_v2
  - Standard_DS4_v2
  - Standard_DS5_v2
scoring_path: /score
scoring_port: 5001

YAML: ze ścieżką instalacji modelu

$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

Następne kroki

  • Last updated on