Partager via


Schéma YAML de planification de tâche CLI (v2)

S’APPLIQUE À :Extension ml Azure CLI v2 (actuelle)

Le schéma JSON source se trouve à l’adresse https://azuremlschemas.azureedge.net/latest/schedule.schema.json.

Notes

La syntaxe YAML détaillée dans ce document est basée sur le schéma JSON pour la dernière version de l’extension ML CLI v2. Le fonctionnement de cette syntaxe est garanti uniquement avec la dernière version de l’extension ML CLI v2. Vous trouverez les schémas des versions d’extension plus anciennes sur https://azuremlschemasprod.azureedge.net/.

Syntaxe YAML

Clé Catégorie Descriptif Valeurs autorisées
$schema ficelle Schéma YAML.
name ficelle Obligatoire. Nom de la planification.
description ficelle Description de la planification.
tags objet Dictionnaire d’étiquettes de la planification.
trigger objet Configuration du déclencheur pour définir la règle précisant quand déclencher un travail. RecurrenceTrigger ou CronTrigger est obligatoire.
create_job Objet ou chaîne Obligatoire. Définition du travail qui sera déclenché par une planification. string ou JobDefinition est obligatoire.

Configuration de déclencheur

Déclencheur recurrence

Clé Catégorie Descriptif Valeurs autorisées
type ficelle Obligatoire. Spécifie le type de planification. récurrence
frequency ficelle Obligatoire. Spécifie l’unité de temps qui décrit la fréquence à laquelle la planification se déclenche. minute, , hourday, , weekmonth
interval entier Obligatoire. Spécifie l’intervalle de déclenchement de la planification.
start_time ficelle Décrit la date et l’heure de début avec le fuseau horaire. Si start_time est omis, le premier travail s’exécute instantanément et les travaux ultérieurs seront déclenchés en fonction de la planification, autrement dit start_time sera égal à l’heure de création du travail. Si l’heure de début est dans le passé, la première charge de travail est exécutée à l’heure d’exécution calculée suivante.
end_time ficelle Décrit la date et l’heure de fin avec le fuseau horaire. Si end_time est omis, la planification continue à s’exécuter jusqu’à ce qu’elle soit explicitement désactivée.
timezone ficelle Spécifie le fuseau horaire de la périodicité. S’il est omis, la valeur par défaut est UTC. Consultez l’annexe pour connaître les valeurs de fuseau horaire.
pattern objet Spécifie le modèle de la périodicité. Si le modèle est omis, le ou les travaux sont déclenchés en fonction de la logique de start_time, de la fréquence et de l’intervalle.

Planification de périodicité

La planification de périodicité définit le modèle de périodicité, contenant hours, minutes et weekdays.

  • Quand la fréquence est day, le modèle peut spécifier hours et minutes.
  • Quand la fréquence est week et month, le modèle peut spécifier hours, minutes et weekdays.
Clé Catégorie Valeurs autorisées
hours entier ou tableau d’entiers 0-23
minutes entier ou tableau d’entiers 0-59
week_days chaîne ou tableau de chaînes monday, tuesday, , wednesdaythursday, friday, , saturday,sunday

CronTrigger

Clé Catégorie Descriptif Valeurs autorisées
type ficelle Obligatoire. Spécifie le type de planification. cron
expression ficelle Obligatoire. Spécifie l’expression cron pour définir comment déclencher les travaux. L’expression utilise l’expression crontab standard pour exprimer une planification périodique. Une expression unique est composée de cinq champs délimités par l’espace :MINUTES HOURS DAYS MONTHS DAYS-OF-WEEK
start_time ficelle Décrit la date et l’heure de début avec le fuseau horaire. Si start_time est omis, le premier travail s’exécute instantanément et les travaux ultérieurs seront déclenchés en fonction de la planification, autrement dit start_time sera égal à l’heure de création du travail. Si l’heure de début est dans le passé, la première charge de travail est exécutée à l’heure d’exécution calculée suivante.
end_time ficelle Décrit la date et l’heure de fin avec le fuseau horaire. Si end_time est omis, la planification continue à s’exécuter jusqu’à ce qu’elle soit explicitement désactivée.
timezone ficelle Spécifie le fuseau horaire de la périodicité. S’il est omis, la valeur par défaut est UTC. Consultez l’annexe pour connaître les valeurs de fuseau horaire.

Définition du travail

Le client peut utiliser create_job: azureml:<job_name> directement ou utiliser les propriétés suivantes pour définir le travail.

Clé Catégorie Descriptif Valeurs autorisées
type ficelle Obligatoire. Spécifie le type de travail. Seul le travail de pipeline est pris en charge. pipeline
job ficelle Obligatoire. Définit comment référencer un travail ; il peut s’agir de azureml:<job_name> ou d’un travail de pipeline local yaml tel que .\hello-pipeline.yml.
experiment_name ficelle Nom de l’expérience sous lequel organiser le travail. Chaque enregistrement d’exécution de travail sera organisé sous l’expérience correspondante sous l’onglet « Expériences » du studio. En cas d’omission, nous prendrons le nom de la planification comme valeur par défaut.
inputs objet Dictionnaire d’entrées du travail. La clé est un nom pour l’entrée dans le contexte du travail et la valeur est la valeur d’entrée.
outputs objet Dictionnaire des configurations de sortie du travail. La clé est un nom pour l’entrée dans le contexte du travail et la valeur est la configuration de sortie.
settings objet Paramètres par défaut pour le travail de pipeline. Consultez les attributs de la clé settings pour l’ensemble des propriétés configurables.

Attributs de la clé settings

Clé Catégorie Descriptif Valeur par défaut
default_datastore ficelle Nom du magasin de données à utiliser comme magasin de données par défaut pour le travail de pipeline. Cette valeur doit être une référence à un magasin de données existant dans l’espace de travail avec la syntaxe azureml:<datastore-name>. Toute sortie définie dans la propriété outputs du travail de pipeline parent ou des travaux d’étape enfants sera stockée dans ce magasin de données. En cas d’omission, les sorties sont stockées dans le magasin de données d’objets blob de l’espace de travail.
default_compute ficelle Nom de la cible de calcul à utiliser comme calcul par défaut pour toutes les étapes du pipeline. Si le calcul est défini au niveau de l’étape, il remplace ce calcul par défaut pour cette étape spécifique. Cette valeur doit être une référence à un calcul existant dans l’espace de travail avec la syntaxe azureml:<compute-name>.
continue_on_step_failure booléen Indique si l’exécution des étapes dans le pipeline doit continuer si une étape échoue. La valeur par défaut est False, ce qui signifie que si une étape échoue, l’exécution du pipeline est arrêtée, en annulant les étapes en cours d’exécution. False

Entrées du travail

Clé Catégorie Descriptif Valeurs autorisées Valeur par défaut
type ficelle Le type d’entrée de travail. Spécifiez uri_file pour les données d’entrée qui pointent vers une source de fichier unique, ou uri_folder pour les données d’entrée qui pointent vers une source de dossier. uri_file, uri_folder uri_folder
path ficelle Le chemin vers les données à utiliser comme entrée. Cela peut être spécifié de plusieurs façons :

- Chemin local du fichier ou dossier de source de données, par exemple path: ./iris.csv. Les données seront chargées lors de l’envoi du travail.

- URI d’un chemin d’accès cloud au fichier ou dossier à utiliser comme entrée. Les types d’URI pris en charge sont azureml, https, wasbs, abfss et adl. Pour plus d’informations sur l’utilisation du format d’URI azureml://, consultez Syntaxe YAML fondamentale.

- Une ressource de données Azure Machine Learning inscrite existante à utiliser comme entrée. Pour référencer une ressource de données inscrite, utilisez la syntaxe azureml:<data_name>:<data_version> ou azureml:<data_name>@latest (pour référencer la dernière version de cette ressource de données), par exemple path: azureml:cifar10-data:1 ou path: azureml:cifar10-data@latest.
mode ficelle Mode de remise des données à la cible de calcul.

Pour un montage en lecture seule (ro_mount), les données sont consommées en tant que chemin de montage. Un dossier est monté en tant que dossier et un fichier est monté en tant que fichier. Azure Machine Learning résout l’entrée vers le chemin de montage.

Pour le mode download, les données sont téléchargées sur la cible de calcul. Azure Machine Learning résout l’entrée vers le chemin téléchargé.

Si vous souhaitez uniquement l’URL de l’emplacement de stockage des artefacts de données plutôt que de monter ou de télécharger les données elles-mêmes, vous pouvez utiliser le mode direct. Cela passe l’URL de l’emplacement de stockage en tant qu’entrée de travail. Dans ce cas, vous êtes entièrement responsable de la gestion des informations d’identification pour accéder au stockage.
ro_mount, , downloaddirect ro_mount

Sorties du travail

Clé Catégorie Descriptif Valeurs autorisées Valeur par défaut
type ficelle Type de sortie du travail. Pour le type uri_folder par défaut, la sortie correspond à un dossier. uri_folder uri_folder
path ficelle Le chemin vers les données à utiliser comme entrée. Cela peut être spécifié de plusieurs façons :

- Chemin local du fichier ou dossier de source de données, par exemple path: ./iris.csv. Les données seront chargées lors de l’envoi du travail.

- URI d’un chemin d’accès cloud au fichier ou dossier à utiliser comme entrée. Les types d’URI pris en charge sont azureml, https, wasbs, abfss et adl. Pour plus d’informations sur l’utilisation du format d’URI azureml://, consultez Syntaxe YAML fondamentale.

- Une ressource de données Azure Machine Learning inscrite existante à utiliser comme entrée. Pour référencer une ressource de données inscrite, utilisez la syntaxe azureml:<data_name>:<data_version> ou azureml:<data_name>@latest (pour référencer la dernière version de cette ressource de données), par exemple path: azureml:cifar10-data:1 ou path: azureml:cifar10-data@latest.
mode ficelle Mode de remise du ou des fichiers de sortie dans le stockage de destination. Pour le mode de montage en lecture-écriture (rw_mount), le répertoire de sortie est un répertoire monté. Pour le mode chargement, le ou les fichiers écrits sont chargés à la fin du travail. rw_mount, upload rw_mount

Remarques

La commande az ml schedule peut être utilisée pour gérer les modèles Azure Machine Learning.

Exemples

Des exemples sont disponibles dans le référentiel d’exemples GitHub. Vous en trouverez quelques-uns ci-dessous.

YAML : Planifier avec un modèle de périodicité

S’APPLIQUE À :Extension ml Azure CLI v2 (actuelle)

$schema: https://azuremlschemas.azureedge.net/latest/schedule.schema.json
name: simple_recurrence_job_schedule
display_name: Simple recurrence job schedule
description: a simple hourly recurrence job schedule

trigger:
  type: recurrence
  frequency: day #can be minute, hour, day, week, month
  interval: 1 #every day
  schedule:
    hours: [4,5,10,11,12]
    minutes: [0,30]
  start_time: "2022-07-10T10:00:00" # optional - default will be schedule creation time
  time_zone: "Pacific Standard Time" # optional - default will be UTC

create_job: ./simple-pipeline-job.yml
# create_job: azureml:simple-pipeline-job

YAML : Planifier avec une expression cron

S’APPLIQUE À :Extension ml Azure CLI v2 (actuelle)

$schema: https://azuremlschemas.azureedge.net/latest/schedule.schema.json
name: simple_cron_job_schedule
display_name: Simple cron job schedule
description: a simple hourly cron job schedule

trigger:
  type: cron
  expression: "0 * * * *"
  start_time: "2022-07-10T10:00:00" # optional - default will be schedule creation time
  time_zone: "Pacific Standard Time" # optional - default will be UTC

# create_job: azureml:simple-pipeline-job
create_job: ./simple-pipeline-job.yml

Annexe

Fuseau horaire

La planification actuelle prend en charge les fuseaux horaires suivants. La clé peut être utilisée directement dans le SDK Python, tandis que la valeur peut être utilisée dans le travail YAML. Le tableau est organisé par UTC (Temps universel coordonné).

UTC Clé Valeur
UTC -12:00 DATELINE_STANDARD_TIME « Dateline Standard Time »
UTC -11:00 UTC_11 « UTC-11 »
UTC - 10:00 ALEUTIAN_STANDARD_TIME Heure standard des îles Aléoutiennes
UTC - 10:00 HAWAIIAN_STANDARD_TIME « Heure standard hawaïenne »
UTC -09:30 MARQUESAS_STANDARD_TIME « Marqueas Standard Time »
UTC -09:00 ALASKAN_STANDARD_TIME « Alaskan Standard Time »
UTC -09:00 UTC_09 « UTC-09 »
UTC -08:00 PACIFIC_STANDARD_TIME_MEXICO « Pacific Standard Time (Mexique) »
UTC -08:00 UTC_08 « UTC-08 »
UTC -08:00 PACIFIC_STANDARD_TIME « Pacific Standard Time »
UTC -07:00 US_MOUNTAIN_STANDARD_TIME « US Mountain Standard Time »
UTC -07:00 MOUNTAIN_STANDARD_TIME_MEXICO « Mountain Standard Time (Mexique) »
UTC -07:00 MOUNTAIN_STANDARD_TIME « Mountain Standard Time »
UTC -06:00 CENTRAL_AMERICA_STANDARD_TIME « Heure standard de l’Amérique centrale »
UTC -06:00 CENTRAL_STANDARD_TIME « Temps standard central »
UTC -06:00 EASTER_ISLAND_STANDARD_TIME « Temps standard de l’île de Pâques »
UTC -06:00 CENTRAL_STANDARD_TIME_MEXICO « Heure standard centrale (Mexique) »
UTC -06:00 CANADA_CENTRAL_STANDARD_TIME « Heure standard centrale du Canada »
UTC -05:00 SA_PACIFIC_STANDARD_TIME « SA Pacific Standard Time »
UTC -05:00 EASTERN_STANDARD_TIME_MEXICO « Heure standard de l’Est (Mexique) »
UTC -05:00 EASTERN_STANDARD_TIME « Heure standard de l’Est »
UTC -05:00 HAITI_STANDARD_TIME « Haïti Standard Time »
UTC -05:00 CUBA_STANDARD_TIME « Cuba Standard Time »
UTC -05:00 US_EASTERN_STANDARD_TIME « Usa Est Standard Time »
UTC -05:00 TURKS_AND_CAICOS_STANDARD_TIME « Turks And Caicos Standard Time »
UTC -04:00 PARAGUAY_STANDARD_TIME « Heure standard du Paraguay »
UTC -04:00 ATLANTIC_STANDARD_TIME « Heure standard de l’Atlantique »
UTC -04:00 VENEZUELA_STANDARD_TIME « Venezuela Standard Time »
UTC -04:00 CENTRAL_BRAZILIAN_STANDARD_TIME « Temps standard du Brésil central »
UTC -04:00 SA_WESTERN_STANDARD_TIME « SA Western Standard Time »
UTC -04:00 PACIFIC_SA_STANDARD_TIME « Pacific SA Standard Time »
UTC -03:30 NEWFOUNDLAND_STANDARD_TIME « Heure standard de Terre-Neuve »
UTC -03:00 TOCANTINS_STANDARD_TIME « Temps standard de Tocantins »
UTC -03:00 E_SOUTH_AMERICAN_STANDARD_TIME "E. Heure standard de l’Amérique du Sud »
UTC -03:00 SA_EASTERN_STANDARD_TIME « SA Eastern Standard Time »
UTC -03:00 ARGENTINA_STANDARD_TIME « Argentine Standard Time »
UTC -03:00 GREENLAND_STANDARD_TIME « Heure standard du Groenland »
UTC -03:00 MONTEVIDEO_STANDARD_TIME « Montevideo Standard Time »
UTC -03:00 SAINT_PIERRE_STANDARD_TIME « Saint Pierre Standard Time »
UTC -03:00 BAHIA_STANDARD_TIM « Heure standard de Bahía »
UTC -02:00 UTC_02 « UTC-02 »
UTC -02:00 MID_ATLANTIC_STANDARD_TIME «Mid-Atlantic Heure standard »
UTC -01:00 AZORES_STANDARD_TIME « Azores Standard Time »
UTC -01:00 CAPE_VERDE_STANDARD_TIME « Cap-Vert Standard Time »
UTC UTC UTC
UTC +00:00 GMT_STANDARD_TIME « Heure standard GMT »
UTC +00:00 GREENWICH_STANDARD_TIME « Heure standard de Greenwich »
UTC +01:00 MOROCCO_STANDARD_TIME « Maroc Standard Time »
UTC +01:00 W_EUROPE_STANDARD_TIME "W. Europe Standard Time"
UTC +01:00 CENTRAL_EUROPE_STANDARD_TIME « Heure standard de l’Europe centrale »
UTC +01:00 ROMANCE_STANDARD_TIME « Romance Standard Time »
UTC +01:00 CENTRAL_EUROPEAN_STANDARD_TIME « Heure standard de l’Europe centrale »
UTC +01:00 W_CENTRAL_AFRICA_STANDARD_TIME "W. Heure standard de l’Afrique centrale »
UTC +02:00 NAMIBIA_STANDARD_TIME « Namibie Standard Time »
UTC +02:00 JORDAN_STANDARD_TIME « Jordan Standard Time »
UTC +02:00 GTB_STANDARD_TIME « Temps standard GTB »
UTC +02:00 MIDDLE_EAST_STANDARD_TIME « Temps standard du Moyen-Orient »
UTC +02:00 EGYPT_STANDARD_TIME « Egypt Standard Time »
UTC +02:00 E_EUROPE_STANDARD_TIME "E. Europe Standard Time"
UTC +02:00 SYRIA_STANDARD_TIME « Temps standard de la Syrie »
UTC +02:00 WEST_BANK_STANDARD_TIME « Heure standard de la Cisjordanie »
UTC +02:00 SOUTH_AFRICA_STANDARD_TIME « Heure standard de l’Afrique du Sud »
UTC +02:00 FLE_STANDARD_TIME « Temps standard FLE »
UTC +02:00 ISRAEL_STANDARD_TIME « Israël Standard Time »
UTC +02:00 KALININGRAD_STANDARD_TIME « Kaliningrad Standard Time »
UTC +02:00 LIBYA_STANDARD_TIME « Temps standard de la Libye »
UTC +03:00 TÜRKIYE_STANDARD_TIME « Heure standard de la Turquie »
UTC +03:00 ARABIC_STANDARD_TIME « Heure standard arabe »
UTC +03:00 ARAB_STANDARD_TIME « Heure standard arabe »
UTC +03:00 BELARUS_STANDARD_TIME « Heure standard du Belarus »
UTC +03:00 RUSSIAN_STANDARD_TIME « Temps standard russe »
UTC +03:00 E_AFRICA_STANDARD_TIME "E. Afrique Standard Time"
UTC +03:30 IRAN_STANDARD_TIME « Iran Standard Time »
UTC +04:00 ARABIAN_STANDARD_TIME « Temps standard arabe »
UTC +04:00 ASTRAKHAN_STANDARD_TIME « Astrakhan Standard Time »
UTC +04:00 AZERBAIJAN_STANDARD_TIME « Azerbaïdjan Standard Time »
UTC +04:00 RUSSIA_TIME_ZONE_3 « Fuseau horaire de Russie 3 »
UTC +04:00 MAURITIUS_STANDARD_TIME « Maurice Standard Time »
UTC +04:00 GEORGIAN_STANDARD_TIME « Heure standard géorgienne »
UTC +04:00 CAUCASUS_STANDARD_TIME « Heure standard du Caucase »
UTC +04:30 AFGHANISTAN_STANDARD_TIME « Afghanistan Standard Time »
UTC +05:00 WEST_ASIA_STANDARD_TIME « Heure standard de l’Asie Ouest »
UTC +05:00 EKATERINBURG_STANDARD_TIME « Ekaterinburg Standard Time »
UTC +05:00 PAKISTAN_STANDARD_TIME « Pakistan Standard Time »
UTC +05:30 INDIA_STANDARD_TIME « Inde Standard Time »
UTC +05:30 SRI_LANKA_STANDARD_TIME « Sri Lanka Standard Time »
UTC +05:45 NEPAL_STANDARD_TIME « Népal Standard Time »
UTC +06:00 CENTRAL_ASIA_STANDARD_TIME « Heure standard de l’Asie centrale »
UTC +06:00 BANGLADESH_STANDARD_TIME « Bangladesh Standard Time »
UTC +06:30 MYANMAR_STANDARD_TIME « Myanmar Standard Time »
UTC +07:00 N_CENTRAL_ASIA_STANDARD_TIME "N. Heure standard de l’Asie centrale »
UTC +07:00 SE_ASIA_STANDARD_TIME « SE Asia Standard Time »
UTC +07:00 ALTAI_STANDARD_TIME « Altai Standard Time »
UTC +07:00 W_MONGOLIA_STANDARD_TIME "W. Heure standard mongole"
UTC +07:00 NORTH_ASIA_STANDARD_TIME « Heure standard de l’Asie du Nord »
UTC +07:00 TOMSK_STANDARD_TIME « Tomsk Standard Time »
UTC +08:00 CHINA_STANDARD_TIME « Chine Standard Time »
UTC +08:00 NORTH_ASIA_EAST_STANDARD_TIME « Heure standard de l’Asie du Nord Est »
UTC +08:00 SINGAPORE_STANDARD_TIME « Singapour Standard Time »
UTC +08:00 W_AUSTRALIA_STANDARD_TIME "W. Australie Standard Time"
UTC +08:00 TAIPEI_STANDARD_TIME « Taipei Standard Time »
UTC +08:00 ULAANBAATAR_STANDARD_TIME « Temps standard Ulaanbaatar »
UTC +08:45 AUS_CENTRAL_W_STANDARD_TIME « Aus Central W. Standard Time »
UTC +09:00 NORTH_KOREA_STANDARD_TIME « Heure standard de la Corée du Nord »
UTC +09:00 TRANSBAIKAL_STANDARD_TIME « Transbaikal Standard Time »
UTC +09:00 TOKYO_STANDARD_TIME « Tokyo Standard Time »
UTC +09:00 KOREA_STANDARD_TIME « Corée Standard Time »
UTC +09:00 YAKUTSK_STANDARD_TIME « Temps standard Yakutsk »
UTC +09:30 CEN_AUSTRALIA_STANDARD_TIME "Cen. Australie Standard Time"
UTC +09:30 AUS_CENTRAL_STANDARD_TIME « AuS Central Standard Time »
UTC +10:00 E_AUSTRALIAN_STANDARD_TIME "E. Australie Standard Time"
UTC +10:00 AUS_EASTERN_STANDARD_TIME « AUS Eastern Standard Time »
UTC +10:00 WEST_PACIFIC_STANDARD_TIME « Heure standard du Pacifique Ouest »
UTC +10:00 TASMANIA_STANDARD_TIME « Tasmania Standard Time »
UTC +10:00 VLADIVOSTOK_STANDARD_TIME « Temps standard Vladivostok »
UTC +10:30 LORD_HOWE_STANDARD_TIME « Lord Howe Standard Time »
UTC +11:00 BOUGAINVILLE_STANDARD_TIME « Bougainville Standard Time »
UTC +11:00 RUSSIA_TIME_ZONE_10 « Zone de temps russie 10 »
UTC +11:00 MAGADAN_STANDARD_TIME « Magadan Standard Time »
UTC +11:00 NORFOLK_STANDARD_TIME « Norfolk Standard Time »
UTC +11:00 SAKHALIN_STANDARD_TIME « Sakhalin Standard Time »
UTC +11:00 CENTRAL_PACIFIC_STANDARD_TIME « Heure standard du Pacifique central »
UTC +12:00 RUSSIA_TIME_ZONE_11 « Zone de temps russie 11 »
UTC +12:00 NEW_ZEALAND_STANDARD_TIME « Heure standard de la Nouvelle-Zélande »
UTC +12:00 UTC_12 « UTC+12 »
UTC +12:00 FIJI_STANDARD_TIME « Fidji Standard Time »
UTC +12:00 KAMCHATKA_STANDARD_TIME « Kamchatka Standard Time »
UTC +12:45 CHATHAM_ISLANDS_STANDARD_TIME « Chatham Islands Standard Time »
UTC +13:00 TONGA__STANDARD_TIME « Temps standard tonga »
UTC +13:00 SAMOA_STANDARD_TIME « Heure standard des Samoa »
UTC +14:00 LINE_ISLANDS_STANDARD_TIME « Line Islands Standard Time »