Compartir vía

Esquema YAML de programación de trabajos de la CLI (v2)

  • Artículo

SE APLICA A: Extensión de ML de la CLI de Azure v2 (actual)

El esquema JSON de origen se puede encontrar en https://azuremlschemas.azureedge.net/latest/schedule.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

Clave Tipo Descripción Valores permitidos
$schema string Esquema de YAML.
name string Necesario. Nombre de la programación.
description string Descripción de la programación.
tags object Diccionario de etiquetas de la programación.
trigger object Configuración de desencadenador para definir la regla que rija cuándo se va a desencadenar el trabajo. Se requiere RecurrenceTrigger o CronTrigger.
create_job objeto o cadena Necesario. Definición del trabajo que se desencadenará mediante una programación. Se requiere string o JobDefinition.

Configuración del desencadenador

Desencadenador de periodicidad

Clave Tipo Descripción Valores permitidos
type string Necesario. Especifica el tipo de programación. recurrence
frequency string Necesario. Especifica la unidad de tiempo que describe la frecuencia con que se activa la programación. minute, hour, day, , week, month
interval integer Necesario. Especifica el intervalo con el que se repite la programación.
start_time string Describe la fecha y hora de inicio con zona horaria. Si se omite start_time, el primer trabajo se ejecutará inmediatamente y los trabajos futuros se desencadenarán según la programación, lo que indica que start_time equivaldrá a la hora de creación del trabajo. Si la hora de inicio pertenece al pasado, el primer trabajo se ejecuta en el siguiente tiempo de ejecución calculado.
end_time string Describe la fecha y hora de finalización con zona horaria. Si se omite end_time, la programación continuará ejecutándose hasta que se deshabilite explícitamente.
timezone string Especifica la zona horaria de la periodicidad. Si se omite, es UTC de forma predeterminada. Vea el apéndice de valores de zona horaria.
pattern object Especifica el patrón de periodicidad. Si se omite el patrón, los trabajos se desencadenarán según la lógica de start_time, frequency e interval.

Programación de periodicidad

La programación de periodicidad define el patrón de periodicidad, que contiene hours, minutes y weekdays.

  • Cuando la frecuencia es day, el patrón puede especificar hours y minutes.
  • Cuando la frecuencia es week y month, el patrón puede especificar hours, minutes y weekdays.
Clave Tipo Valores permitidos
hours entero o matriz de enteros 0-23
minutes entero o matriz de enteros 0-59
week_days cadena o matriz de cadenas monday, tuesday, wednesday, thursday, friday, , saturdaysunday

CronTrigger

Clave Tipo Descripción Valores permitidos
type string Necesario. Especifica el tipo de programación. cron
expression string Necesario. Especifica la expresión CRON para definir cómo desencadenar trabajos. expression usa una expresión crontab estándar para expresar una programación periódica. Una expresión se compone de cinco campos delimitados por espacios: MINUTES HOURS DAYS MONTHS DAYS-OF-WEEK
start_time string Describe la fecha y hora de inicio con zona horaria. Si se omite start_time, el primer trabajo se ejecutará inmediatamente y los trabajos futuros se desencadenarán según la programación, lo que indica que start_time equivaldrá a la hora de creación del trabajo. Si la hora de inicio pertenece al pasado, el primer trabajo se ejecuta en el siguiente tiempo de ejecución calculado.
end_time string Describe la fecha y hora de finalización con zona horaria. Si se omite end_time, la programación continuará ejecutándose hasta que se deshabilite explícitamente.
timezone string Especifica la zona horaria de la periodicidad. Si se omite, es UTC de forma predeterminada. Vea el apéndice de valores de zona horaria.

Definición del trabajo

El cliente puede usar create_job: azureml:<job_name> directamente, o bien usar las siguientes propiedades para definir el trabajo.

Clave Tipo Descripción Valores permitidos
type string Necesario. Especifica el tipo de trabajo. Solo se admiten trabajos de canalización. pipeline
job string Necesario. Defina cómo hacer referencia a un trabajo; puede ser azureml:<job_name> o un archivo yaml de trabajo de canalización local, como file:hello-pipeline.yml.
experiment_name string Nombre del experimento en el que se va a organizar el trabajo. El registro de ejecución de cada trabajo se organizará dentro del experimento correspondiente en la pestaña "Experiments" del estudio. Si se omite, tomaremos el nombre de la programación como valor predeterminado.
inputs object Diccionario de entradas para el trabajo. La clave es un nombre para la entrada dentro del contexto del trabajo y el valor es el valor de entrada.
outputs object Diccionario de configuraciones de salida del trabajo. La clave es un nombre para la salida dentro del contexto del trabajo y el valor es la configuración de salida.
settings object Configuración predeterminada del trabajo de canalización. Consulte Atributos de la clave settings para ver el conjunto de propiedades configurables.

Atributos de la clave settings

Clave Tipo Descripción Valor predeterminado
default_datastore string Nombre del almacén de datos que se usará como almacén de datos predeterminado para el trabajo de canalización. Este valor debe ser una referencia a un almacén de datos existente en el área de trabajo mediante la sintaxis azureml:<datastore-name>. Las salidas definidas en la propiedad outputs del trabajo de canalización primario o los trabajos de paso secundario se almacenarán en este almacén de datos. Si se omite, las salidas se almacenarán en el almacén de datos de blobs del área de trabajo.
default_compute string Nombre del destino de proceso que se va a usar como proceso predeterminado para todos los pasos de la canalización. Si el proceso se define en el nivel de paso, invalidará este proceso predeterminado para ese paso específico. Este valor debe ser una referencia a un proceso existente en el área de trabajo mediante la sintaxis azureml:<compute-name>.
continue_on_step_failure boolean Indica si la ejecución de los pasos de la canalización debe continuar si se produce un error en un paso. El valor predeterminado es False, lo que significa que, si se produce un error en un paso, la ejecución de la canalización se detendrá y cancelará los pasos en ejecución. False

Entradas de trabajo

Clave Tipo Descripción Valores permitidos Valor predeterminado
type string Tipo de entrada de trabajo. Especifique uri_file para los datos de entrada que apunte a un único origen de archivo o uri_folder para los datos de entrada que apunte a un origen de carpeta. uri_file, uri_folder uri_folder
path string Ruta de acceso a los datos que se va a usar como entrada. Esto se puede especificar de varias maneras:

- Ruta de acceso local al archivo o carpeta del origen de datos, por ejemplo, path: ./iris.csv. Los datos se cargarán durante el envío del trabajo.

- URI de una ruta de acceso a la nube al archivo o carpeta que se va a usar como entrada. Los tipos de URI admitidos son azureml, https, wasbs, abfss, adl. Para más información sobre cómo usar el formato de URI azureml://, consulte Sintaxis principal de YAML.

- Recurso de datos de Azure Machine Learning registrado existente que se va a usar como entrada. Para hacer referencia a un recurso de datos registrado, use la sintaxis azureml:<data_name>:<data_version> o azureml:<data_name>@latest (para hacer referencia a la versión más reciente de ese recurso de datos), por ejemplo, path: azureml:cifar10-data:1 o path: azureml:cifar10-data@latest.
mode string Modo de cómo se deben entregar los datos al destino de proceso.

Para el montaje de solo lectura (ro_mount), el conjunto de datos se consumirá como una ruta de acceso de montaje. Una carpeta se montará como una carpeta y un archivo se montará como un archivo. Azure Machine Learning resolverá la entrada en la ruta de acceso de montaje.

Para el modo download, los datos se descargarán en el destino de proceso. Azure Machine Learning resolverá la entrada a la ruta de acceso descargada.

Si solo desea la dirección URL de la ubicación de almacenamiento de los artefactos de datos en lugar de montar o descargar los datos en sí, puede usar el modo direct. Esto pasará la dirección URL de la ubicación de almacenamiento como entrada del trabajo. En este caso, el usuario es el único responsable de controlar las credenciales para acceder al almacenamiento.		 ro_mount, , download, direct ro_mount

Salidas de trabajo

Clave Tipo Descripción Valores permitidos Valor predeterminado
type string Tipo de salida del trabajo. Para el tipo predeterminado uri_folder, la salida corresponderá a una carpeta. uri_folder uri_folder
path string Ruta de acceso a los datos que se va a usar como entrada. Esto se puede especificar de varias maneras:

- Ruta de acceso local al archivo o carpeta del origen de datos, por ejemplo, path: ./iris.csv. Los datos se cargarán durante el envío del trabajo.

- URI de una ruta de acceso a la nube al archivo o carpeta que se va a usar como entrada. Los tipos de URI admitidos son azureml, https, wasbs, abfss, adl. Para más información sobre cómo usar el formato de URI azureml://, consulte Sintaxis principal de YAML.

- Recurso de datos de Azure Machine Learning registrado existente que se va a usar como entrada. Para hacer referencia a un recurso de datos registrado, use la sintaxis azureml:<data_name>:<data_version> o azureml:<data_name>@latest (para hacer referencia a la versión más reciente de ese recurso de datos), por ejemplo, path: azureml:cifar10-data:1 o path: azureml:cifar10-data@latest.
mode string Modo de cómo se entregarán los archivos de salida al almacenamiento de destino. Para el modo de montaje de lectura y escritura (rw_mount), el directorio de salida será un directorio montado. En el modo de carga, los archivos escritos se cargan al final del trabajo. rw_mount, upload rw_mount

Comentarios

El comando az ml schedule se puede usar para administrar los modelos de Azure Machine Learning.

Ejemplos

Hay ejemplos disponibles en el repositorio de GitHub de ejemplos. Aquí se muestran un par de ellos.

YAML: Programación con un patrón de periodicidad

SE APLICA A: Extensión de ML de la CLI de Azure v2 (actual)

$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: Programación con una expresión CRON

SE APLICA A: Extensión de ML de la CLI de Azure v2 (actual)

$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

Apéndice

Zona horaria

La programación actual admite las siguientes zonas horarias. La clave se puede usar directamente en el SDK de Python, mientras que el valor se puede usar en el trabajo de YAML. La tabla está organizada por UTC (Hora universal coordinada).

UTC Clave Valor
UTC -12:00 DATELINE_STANDARD_TIME "Hora estándar de línea de fecha"
UTC -11:00 UTC_11 "UTC-11"
UTC - 10:00 ALEUTIAN_STANDARD_TIME Hora estándar aleutiana
UTC - 10:00 HAWAIIAN_STANDARD_TIME "Hora estándar de Hawái"
UTC -09:30 MARQUESAS_STANDARD_TIME "Hora estándar de Marquesas"
UTC -09:00 ALASKAN_STANDARD_TIME "Hora estándar de Alaska"
UTC -09:00 UTC_09 "UTC-09"
UTC -08:00 PACIFIC_STANDARD_TIME_MEXICO "Hora estándar del Pacífico (México)"
UTC -08:00 UTC_08 "UTC-08"
UTC -08:00 PACIFIC_STANDARD_TIME "Hora estándar del Pacífico"
UTC -07:00 US_MOUNTAIN_STANDARD_TIME "Hora estándar de las Montañas, EE. UU."
UTC -07:00 MOUNTAIN_STANDARD_TIME_MEXICO "Hora estándar de las Montañas (México)"
UTC -07:00 MOUNTAIN_STANDARD_TIME "Hora estándar de las Montañas"
UTC -06:00 CENTRAL_AMERICA_STANDARD_TIME "Hora estándar de Centroamérica"
UTC -06:00 CENTRAL_STANDARD_TIME "Hora estándar central"
UTC -06:00 EASTER_ISLAND_STANDARD_TIME "Hora estándar de Isla de Pascua"
UTC -06:00 CENTRAL_STANDARD_TIME_MEXICO "Hora estándar central (México)"
UTC -06:00 CANADA_CENTRAL_STANDARD_TIME "Hora estándar de Canadá central"
UTC -05:00 SA_PACIFIC_STANDARD_TIME "Hora estándar del Pacífico, Sudamérica"
UTC -05:00 EASTERN_STANDARD_TIME_MEXICO "Hora estándar del Este (México)"
UTC -05:00 EASTERN_STANDARD_TIME "Hora estándar del Este"
UTC -05:00 HAITI_STANDARD_TIME "Hora estándar de Haití"
UTC -05:00 CUBA_STANDARD_TIME "Hora estándar de Cuba"
UTC -05:00 US_EASTERN_STANDARD_TIME "Hora estándar del Este, EE. UU."
UTC -05:00 TURKS_AND_CAICOS_STANDARD_TIME "Hora estándar de Islas Turcas y Caicos"
UTC -04:00 PARAGUAY_STANDARD_TIME "Hora estándar de Paraguay"
UTC -04:00 ATLANTIC_STANDARD_TIME "Hora estándar del Atlántico"
UTC -04:00 VENEZUELA_STANDARD_TIME "Hora estándar de Venezuela"
UTC -04:00 CENTRAL_BRAZILIAN_STANDARD_TIME "Hora estándar de Brasil central"
UTC -04:00 SA_WESTERN_STANDARD_TIME "Hora estándar oeste, Sudamérica"
UTC -04:00 PACIFIC_SA_STANDARD_TIME "Hora estándar del Pacífico, Sudamérica"
UTC -03:30 NEWFOUNDLAND_STANDARD_TIME "Hora estándar de Terranova"
UTC -03:00 TOCANTINS_STANDARD_TIME "Hora estándar de Tocantins"
UTC -03:00 E_SOUTH_AMERICAN_STANDARD_TIME "E. Hora estándar este, Sudamérica"
UTC -03:00 SA_EASTERN_STANDARD_TIME "Hora estándar de Sudamérica Este"
UTC -03:00 ARGENTINA_STANDARD_TIME "Hora estándar de Argentina"
UTC -03:00 GREENLAND_STANDARD_TIME "Hora estándar de Groenlandia"
UTC -03:00 MONTEVIDEO_STANDARD_TIME "Hora estándar de Montevideo"
UTC -03:00 SAINT_PIERRE_STANDARD_TIME "Hora estándar de Saint Pierre"
UTC -03:00 BAHIA_STANDARD_TIM "Hora estándar de Bahía"
UTC -02:00 UTC_02 "UTC-02"
UTC -02:00 MID_ATLANTIC_STANDARD_TIME "Hora estándar del Atlántico Central"
UTC -01:00 AZORES_STANDARD_TIME "Hora estándar de las Azores"
UTC -01:00 CAPE_VERDE_STANDARD_TIME "Hora estándar de Cabo Verde"
UTC UTC UTC
UTC +00:00 GMT_STANDARD_TIME "Hora estándar GMT"
UTC +00:00 GREENWICH_STANDARD_TIME "Hora estándar de Greenwich"
UTC +01:00 MOROCCO_STANDARD_TIME "Hora estándar de Marruecos"
UTC +01:00 W_EUROPE_STANDARD_TIME "Hora estándar Europa Occidental"
UTC +01:00 CENTRAL_EUROPE_STANDARD_TIME "Hora estándar Europa Central"
UTC +01:00 ROMANCE_STANDARD_TIME "Hora estándar romance"
UTC +01:00 CENTRAL_EUROPEAN_STANDARD_TIME "Hora estándar centroeuropea"
UTC +01:00 W_CENTRAL_AFRICA_STANDARD_TIME "Hora estándar de África Central Occidental"
UTC +02:00 NAMIBIA_STANDARD_TIME "Hora estándar de Namibia"
UTC +02:00 JORDAN_STANDARD_TIME "Hora estándar de Jordania"
UTC +02:00 GTB_STANDARD_TIME "Hora estándar GTB"
UTC +02:00 MIDDLE_EAST_STANDARD_TIME "Hora estándar de Oriente Medio"
UTC +02:00 EGYPT_STANDARD_TIME "Hora estándar de Egipto"
UTC +02:00 E_EUROPE_STANDARD_TIME "E. estándar Europa Occidental"
UTC +02:00 SYRIA_STANDARD_TIME "Hora estándar de Siria"
UTC +02:00 WEST_BANK_STANDARD_TIME "Hora estándar de Cisjordania"
UTC +02:00 SOUTH_AFRICA_STANDARD_TIME "Hora estándar de Sudáfrica"
UTC +02:00 FLE_STANDARD_TIME "Hora estándar FLE"
UTC +02:00 ISRAEL_STANDARD_TIME "Hora estándar de Israel"
UTC +02:00 KALININGRAD_STANDARD_TIME "Hora estándar de Kaliningrado"
UTC +02:00 LIBYA_STANDARD_TIME "Hora estándar de Libia"
UTC +03:00 TÜRKIYE_STANDARD_TIME "Hora estándar de Turquía"
UTC +03:00 ARABIC_STANDARD_TIME "Hora estándar arábiga"
UTC +03:00 ARAB_STANDARD_TIME "Hora estándar árabe"
UTC +03:00 BELARUS_STANDARD_TIME "Hora estándar de Bielorrusia"
UTC +03:00 RUSSIAN_STANDARD_TIME "Hora estándar de Rusia"
UTC +03:00 E_AFRICA_STANDARD_TIME "E. Hora estándar de África"
UTC +03:30 IRAN_STANDARD_TIME "Hora estándar de Irán"
UTC +04:00 ARABIAN_STANDARD_TIME "Hora estándar árabe"
UTC +04:00 ASTRAKHAN_STANDARD_TIME "Hora estándar de Astrakhan"
UTC +04:00 AZERBAIJAN_STANDARD_TIME "Hora estándar de Azerbaiyán"
UTC +04:00 RUSSIA_TIME_ZONE_3 "Zona horaria 3 de Rusia"
UTC +04:00 MAURITIUS_STANDARD_TIME "Hora estándar de Mauricio"
UTC +04:00 GEORGIAN_STANDARD_TIME "Hora estándar de Georgia"
UTC +04:00 CAUCASUS_STANDARD_TIME "Hora estándar del Cáucaso"
UTC +04:30 AFGHANISTAN_STANDARD_TIME "Hora estándar de Afganistán"
UTC +05:00 WEST_ASIA_STANDARD_TIME "Hora estándar Asia Occidental"
UTC +05:00 EKATERINBURG_STANDARD_TIME "Hora estándar de Ekaterimburgo"
UTC +05:00 PAKISTAN_STANDARD_TIME "Hora estándar de Pakistán"
UTC +05:30 INDIA_STANDARD_TIME "Hora estándar de India"
UTC +05:30 SRI_LANKA_STANDARD_TIME "Hora estándar de Sri Lanka"
UTC +05:45 NEPAL_STANDARD_TIME "Hora estándar de Nepal"
UTC +06:00 CENTRAL_ASIA_STANDARD_TIME "Hora estándar de Asia Central"
UTC +06:00 BANGLADESH_STANDARD_TIME "Hora estándar de Bangladés"
UTC +06:30 MYANMAR_STANDARD_TIME "Hora estándar de Myanmar"
UTC +07:00 N_CENTRAL_ASIA_STANDARD_TIME "Hora estándar de Asia Central Norte"
UTC +07:00 SE_ASIA_STANDARD_TIME "Hora estándar de Asia Sureste"
UTC +07:00 ALTAI_STANDARD_TIME "Hora estándar de Altai"
UTC +07:00 W_MONGOLIA_STANDARD_TIME "Hora estándar de Mongolia Occidental"
UTC +07:00 NORTH_ASIA_STANDARD_TIME "Hora estándar de Asia Norte"
UTC +07:00 TOMSK_STANDARD_TIME "Hora estándar de Tomsk"
UTC +08:00 CHINA_STANDARD_TIME "Hora estándar de China"
UTC +08:00 NORTH_ASIA_EAST_STANDARD_TIME "Hora estándar del este de Asia Norte"
UTC +08:00 SINGAPORE_STANDARD_TIME "Hora estándar de Singapur"
UTC +08:00 W_AUSTRALIA_STANDARD_TIME "Hora estándar de Australia occidental"
UTC +08:00 TAIPEI_STANDARD_TIME "Hora estándar de Taipéi"
UTC +08:00 ULAANBAATAR_STANDARD_TIME "Hora estándar de Ulán Bator"
UTC +08:45 AUS_CENTRAL_W_STANDARD_TIME "Hora estándar de Australia Central Oeste"
UTC +09:00 NORTH_KOREA_STANDARD_TIME "Hora estándar de Corea del Norte"
UTC +09:00 TRANSBAIKAL_STANDARD_TIME "Hora estándar de Transbaikal"
UTC +09:00 TOKYO_STANDARD_TIME "Hora estándar de Tokio"
UTC +09:00 KOREA_STANDARD_TIME "Hora estándar de Corea"
UTC +09:00 YAKUTSK_STANDARD_TIME "Hora estándar de Yakutsk"
UTC +09:30 CEN_AUSTRALIA_STANDARD_TIME "Hora estándar de Australia central"
UTC +09:30 AUS_CENTRAL_STANDARD_TIME "Hora estándar central australiana"
UTC +10:00 E_AUSTRALIAN_STANDARD_TIME "E. estándar de Australia oriental"
UTC +10:00 AUS_EASTERN_STANDARD_TIME "Hora estándar oriental australiana"
UTC +10:00 WEST_PACIFIC_STANDARD_TIME "Hora estándar del Pacífico Occidental"
UTC +10:00 TASMANIA_STANDARD_TIME "Hora estándar de Tasmania"
UTC +10:00 VLADIVOSTOK_STANDARD_TIME "Hora estándar de Vladivostok"
UTC +10:30 LORD_HOWE_STANDARD_TIME "Hora estándar de Lord Howe"
UTC +11:00 BOUGAINVILLE_STANDARD_TIME "Hora estándar de Bougainville"
UTC +11:00 RUSSIA_TIME_ZONE_10 "Zona horaria 10 de Rusia"
UTC +11:00 MAGADAN_STANDARD_TIME "Hora estándar de Magadán"
UTC +11:00 NORFOLK_STANDARD_TIME "Hora estándar de Norfolk"
UTC +11:00 SAKHALIN_STANDARD_TIME "Hora estándar de Sajalín"
UTC +11:00 CENTRAL_PACIFIC_STANDARD_TIME "Hora estándar del Pacífico Central"
UTC +12:00 RUSSIA_TIME_ZONE_11 "Zona horaria 11 de Rusia"
UTC +12:00 NEW_ZEALAND_STANDARD_TIME "Hora estándar de Nueva Zelanda"
UTC +12:00 UTC_12 "UTC+12"
UTC +12:00 FIJI_STANDARD_TIME "Hora estándar de Fiyi"
UTC +12:00 KAMCHATKA_STANDARD_TIME "Hora estándar de Kamchatka"
UTC +12:45 CHATHAM_ISLANDS_STANDARD_TIME "Hora estándar de las Islas Chatham"
UTC +13:00 TONGA__STANDARD_TIME "Hora estándar de Tonga"
UTC +13:00 SAMOA_STANDARD_TIME "Hora estándar de Samoa"
UTC +14:00 LINE_ISLANDS_STANDARD_TIME "Hora estándar de Islas de la Línea"