Compartilhar via

Esquema YAML de agendamento de trabalhos da CLI (v2)

  • Artigo

APLICA-SE A: Extensão de ML da CLI do Azurev2 (atual)

O esquema JSON de origem pode ser encontrado em https://azuremlschemas.azureedge.net/latest/schedule.schema.json.

Observação

A sintaxe YAML detalhada neste documento baseia-se no esquema JSON da última versão da extensão de ML da CLI v2. Essa sintaxe só tem a garantia de funcionar com a última versão da extensão de ML da CLI v2. Encontre os esquemas para as versões mais antigas da extensão em https://azuremlschemasprod.azureedge.net/.

Sintaxe YAML

Chave Type Descrição Valores permitidos
$schema string O esquema YAML.
name string Obrigatórios. Nome da agenda.
description string Descrição do agendamento.
tags objeto Dicionário de marcas para o agendamento.
trigger objeto A configuração do gatilho para definir a regra de quando disparar o trabalho. Um dos dois é obrigatório, RecurrenceTrigger ou CronTrigger.
create_job objeto ou cadeia de caracteres Obrigatórios. A definição do trabalho que será disparado por um agendamento. Um dos dois é obrigatório, string ou JobDefinition.

Configuração de gatilho

Gatilho de recorrência

Chave Type Descrição Valores permitidos
type string Obrigatórios. Especifica o tipo de agendamento. recurrence
frequency string Obrigatórios. Especifica a unidade de tempo que descreve a frequência com que o agendamento é acionado. minute, hour, day, week, month
interval Número inteiro Obrigatórios. Especifica o intervalo no qual o agendamento é acionado.
start_time string Descreve a data e a hora de início com fuso horário. Se start_time for omitido, o primeiro trabalho será executado instantaneamente e os trabalhos futuros serão disparados com base no agendamento, dizendo que start_time será igual à hora de criação do trabalho. Se a hora de início estiver no passado, o primeiro trabalho será executado no próximo tempo de execução calculado.
end_time string Descreve a data e a hora de término com fuso horário. Se end_time for omitido, o agendamento continuará a ser executado até que seja explicitamente desabilitado.
timezone string Especifica o fuso horário da recorrência. Se omitido, por padrão será UTC. Consulte o apêndice para obter valores de fuso horário
pattern objeto Especifica o padrão da recorrência. Se o padrão for omitido, os trabalhos serão disparados de acordo com a lógica de start_time, frequência e intervalo.

Agendamento de recorrência

O agendamento de recorrência define o padrão de recorrência, contendo hours, minutes e weekdays.

  • Quando a frequência é day, o padrão pode especificar hours e minutes.
  • Quando a frequência é week e month, o padrão pode especificar hours, minutes e weekdays.
Chave Type Valores permitidos
hours inteiro ou matriz de inteiro 0-23
minutes inteiro ou matriz de inteiro 0-59
week_days cadeia de caracteres ou matriz de cadeias de caracteres monday, tuesday, wednesday, thursday, friday, saturday, , sunday

CronTrigger

Chave Type Descrição Valores permitidos
type string Obrigatórios. Especifica o tipo de agendamento. cron
expression string Obrigatórios. Especifica a expressão cron para definir como disparar trabalhos. expressão usa a expressão crontab padrão para expressar um agendamento recorrente. Uma única expressão é composta por cinco campos delimitados por espaço:MINUTES HOURS DAYS MONTHS DAYS-OF-WEEK
start_time string Descreve a data e a hora de início com fuso horário. Se start_time for omitido, o primeiro trabalho será executado instantaneamente e os trabalhos futuros serão disparados com base no agendamento, dizendo que start_time será igual à hora de criação do trabalho. Se a hora de início estiver no passado, o primeiro trabalho será executado no próximo tempo de execução calculado.
end_time string Descreve a data e a hora de término com fuso horário. Se end_time for omitido, o agendamento continuará a ser executado até que seja explicitamente desabilitado.
timezone string Especifica o fuso horário da recorrência. Se omitido, por padrão será UTC. Consulte o apêndice para obter valores de fuso horário

Definição de trabalho

O cliente pode usar create_job: azureml:<job_name> diretamente ou pode usar as propriedades a seguir para definir o trabalho.

Chave Type Descrição Valores permitidos
type string Obrigatórios. Especifica o tipo de trabalho. Há suporte apenas para o trabalho de pipeline. pipeline
job string Obrigatórios. Defina como referenciar um trabalho. Ele pode ser azureml:<job_name> ou um yaml de trabalho de pipeline local, como file:hello-pipeline.yml.
experiment_name string Nome do experimento sob o qual o trabalho é organizado. O registro de execução de cada trabalho será organizado sob o experimento correspondente na guia "Experimentos" do estúdio. Se omitido, usaremos o nome do agendamento como valor padrão.
inputs objeto Dicionário de entradas para o trabalho. A chave é um nome para a entrada dentro do contexto do trabalho e o valor é o valor de entrada.
outputs objeto Dicionário de configurações de saída do trabalho. A chave é um nome para a saída dentro do contexto do trabalho e o valor é a configuração de saída.
settings objeto Configurações padrão para o trabalho de pipeline. Veja Atributos da settings chave para obter o conjunto de propriedades configuráveis.

Atributos da chave settings

Chave Type Descrição Valor padrão
default_datastore string Nome do armazenamento de dados a ser usado como o armazenamento de dados padrão para o trabalho de pipeline. Esse valor precisa ser uma referência a uma computação existente no armazenamento de dados com a sintaxe azureml:<datastore-name>. As saídas definidas na propriedade outputs do trabalho de pipeline pai ou dos trabalhos de etapa filho serão armazenadas nesse armazenamento de dados. Se omitido, as saídas serão armazenadas no armazenamento de dados de blob do espaço de trabalho.
default_compute string Nome do destino de computação a ser usado como a computação padrão para todas as etapas no pipeline. Se a computação for definida no nível da etapa, ela substituirá a computação padrão por essa etapa específica. Esse valor precisa ser uma referência a uma computação existente no espaço de trabalho com a sintaxe azureml:<compute-name>.
continue_on_step_failure booleano Se a execução das etapas no pipeline deve continuar se uma etapa falhar. O valor padrão é False, o que significa que, se uma etapa falhar, a execução do pipeline será interrompida, cancelando todas as etapas em execução. False

Entradas de trabalho

Chave Type Descrição Valores permitidos Valor padrão
type string O tipo de entrada de trabalho. Especifique uri_file para dados de entrada que apontem para uma única fonte de arquivo ou uri_folder para dados de entrada que apontem para uma fonte de pasta. uri_file, uri_folder uri_folder
path string O caminho para os dados a serem usados como entrada. Isso pode ser especificado de algumas maneiras:

– Um caminho local para o arquivo ou pasta da fonte de dados, por exemplo, path: ./iris.csv. Os dados serão carregados durante o envio do trabalho.

- Um URI de um caminho de nuvem para o arquivo ou pasta a ser usado como entrada. Os tipos de URI com suporte são azureml, https, wasbs, abfss, adl. Para saber mais sobre como usar o formato URI azureml://, confira Sintaxe principal do YAML.

– Um ativo de dados existente e registrado do Azure Machine Learning a ser usado como a entrada. Para fazer referência a um ativo de dados registrado, use a sintaxe azureml:<data_name>:<data_version> ou azureml:<data_name>@latest (para fazer referência à versão mais recente desse ativo de dados), por exemplo, path: azureml:cifar10-data:1 ou path: azureml:cifar10-data@latest.
mode string Modo como os dados devem ser entregues ao destino de computação.

Na montagem somente leitura (ro_mount), os dados serão consumidos como um caminho de montagem. Uma pasta será montada como uma pasta e um arquivo será montado como um arquivo. O Azure Machine Learning resolverá a entrada para o caminho de montagem.

Para o modo download, os dados serão baixados para o destino de computação. O Azure Machine Learning resolverá a entrada para o caminho baixado.

Se desejar somente a URL do local de armazenamento dos artefatos de dados em vez de montar ou baixar os próprios dados, você pode usar o modo direct. Isso passará a URL do local de armazenamento como a entrada do trabalho. Nesse caso, você é totalmente responsável por identificar credenciais para acessar o armazenamento.		 ro_mount, download, direct ro_mount

Saídas de trabalho

Chave Type Descrição Valores permitidos Valor padrão
type string O tipo de saída de trabalho. Para o tipo padrão uri_folder, a saída corresponderá a uma pasta. uri_folder uri_folder
path string O caminho para os dados a serem usados como entrada. Isso pode ser especificado de algumas maneiras:

– Um caminho local para o arquivo ou pasta da fonte de dados, por exemplo, path: ./iris.csv. Os dados serão carregados durante o envio do trabalho.

- Um URI de um caminho de nuvem para o arquivo ou pasta a ser usado como entrada. Os tipos de URI com suporte são azureml, https, wasbs, abfss, adl. Para saber mais sobre como usar o formato URI azureml://, confira Sintaxe principal do YAML.

– Um ativo de dados existente e registrado do Azure Machine Learning a ser usado como a entrada. Para fazer referência a um ativo de dados registrado, use a sintaxe azureml:<data_name>:<data_version> ou azureml:<data_name>@latest (para fazer referência à versão mais recente desse ativo de dados), por exemplo, path: azureml:cifar10-data:1 ou path: azureml:cifar10-data@latest.
mode string Modo como os arquivos de saída serão entregues ao armazenamento de destino. No modo de montagem de leitura/gravação (rw_mount), o diretório de saída será um diretório montado. No modo de upload, os arquivos gravados serão carregados no final do trabalho. rw_mount, upload rw_mount

Comentários

O comando az ml schedule pode ser usado para gerenciar modelos do Azure Machine Learning.

Exemplos

Os exemplos estão disponíveis no repositório de exemplos do GitHub. Alguns são mostrados abaixo.

YAML: Agendamento com padrão de recorrência

APLICA-SE A: Extensão de ML da CLI do Azurev2 (atual)

$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: Agendamento com a expressão cron

APLICA-SE A: Extensão de ML da CLI do Azurev2 (atual)

$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

Fuso horário

O agendamento atual dá suporte aos fusos horários a seguir. A chave pode ser usada diretamente no SDK do Python, enquanto o valor pode ser usado no trabalho YAML. A tabela está organizada por UTC (Tempo Universal Coordenado).

UTC Chave Valor
UTC -12:00 DATELINE_STANDARD_TIME “Hora Oficial do Meridiano de Data”
UTC -11:00 UTC_11 "UTC-11"
UTC - 10:00 ALEUTIAN_STANDARD_TIME Hora Padrão das Aleutas
UTC - 10:00 HAWAIIAN_STANDARD_TIME “Hora Oficial do Havaí”
UTC -09:30 MARQUESAS_STANDARD_TIME “Hora Oficial de Marquesas”
UTC -09:00 ALASKAN_STANDARD_TIME “Hora Oficial do Alasca”
UTC -09:00 UTC_09 "UTC-09"
UTC -08:00 PACIFIC_STANDARD_TIME_MEXICO “Hora Oficial do Pacífico (México)”
UTC -08:00 UTC_08 "UTC-08"
UTC -08:00 PACIFIC_STANDARD_TIME “Hora Oficial do Pacífico”
UTC -07:00 US_MOUNTAIN_STANDARD_TIME “Hora Oficial das Montanhas dos EUA”
UTC -07:00 MOUNTAIN_STANDARD_TIME_MEXICO “Hora Padrão das Montanhas (México)”
UTC -07:00 MOUNTAIN_STANDARD_TIME “Hora Oficial das Montanhas”
UTC -06:00 CENTRAL_AMERICA_STANDARD_TIME “Hora Oficial da América Central”
UTC -06:00 CENTRAL_STANDARD_TIME “Hora Oficial Central”
UTC -06:00 EASTER_ISLAND_STANDARD_TIME “Hora Oficial da Ilha da Páscoa”
UTC -06:00 CENTRAL_STANDARD_TIME_MEXICO “Hora Oficial Central (México)”
UTC -06:00 CANADA_CENTRAL_STANDARD_TIME “Hora Oficial do Canadá Central”
UTC -05:00 SA_PACIFIC_STANDARD_TIME “Hora Oficial do Pacífico na América do Sul”
UTC -05:00 EASTERN_STANDARD_TIME_MEXICO “Hora Oficial Oriental (México)”
UTC -05:00 EASTERN_STANDARD_TIME “Hora Oficial do Leste dos EUA”
UTC -05:00 HAITI_STANDARD_TIME “Hora Oficial do Haiti”
UTC -05:00 CUBA_STANDARD_TIME “Hora Oficial de Cuba”
UTC -05:00 US_EASTERN_STANDARD_TIME “Hora Oficial do Leste dos EUA”
UTC -05:00 TURKS_AND_CAICOS_STANDARD_TIME “Hora Oficial Turcos e Caicos”
UTC -04:00 PARAGUAY_STANDARD_TIME “Hora Oficial do Paraguai”
UTC -04:00 ATLANTIC_STANDARD_TIME “Hora Oficial do Atlântico”
UTC -04:00 VENEZUELA_STANDARD_TIME “Hora Oficial da Venezuela”
UTC -04:00 CENTRAL_BRAZILIAN_STANDARD_TIME “Hora Oficial do Brasil Central”
UTC -04:00 SA_WESTERN_STANDARD_TIME “Hora Oficial do Oeste da América do Sul”
UTC -04:00 PACIFIC_SA_STANDARD_TIME “Hora Oficial do Pacífico SA”
UTC -03:30 NEWFOUNDLAND_STANDARD_TIME “Hora Oficial de Newfoundland”
UTC -03:00 TOCANTINS_STANDARD_TIME “Hora Oficial de Tocantins”
UTC -03:00 E_SOUTH_AMERICAN_STANDARD_TIME “E. Hora Oficial do Brasil”
UTC -03:00 SA_EASTERN_STANDARD_TIME “Hora Oficial de Buenos Aires”
UTC -03:00 ARGENTINA_STANDARD_TIME “Hora Oficial da Argentina”
UTC -03:00 GREENLAND_STANDARD_TIME “Hora Oficial da Groenlândia”
UTC -03:00 MONTEVIDEO_STANDARD_TIME “Hora Oficial de Montevidéu”
UTC -03:00 SAINT_PIERRE_STANDARD_TIME “Hora Oficial de Saint Pierre”
UTC -03:00 BAHIA_STANDARD_TIM “Hora Oficial da Bahia”
UTC -02:00 UTC_02 "UTC-02"
UTC -02:00 MID_ATLANTIC_STANDARD_TIME “Hora Oficial do Atlântico Central”
UTC -01:00 AZORES_STANDARD_TIME “Hora Oficial dos Açores”
UTC -01:00 CAPE_VERDE_STANDARD_TIME “Hora Oficial do Cabo Verde”
UTC UTC UTC
UTC +00:00 GMT_STANDARD_TIME “Hora Oficial GMT”
UTC +00:00 GREENWICH_STANDARD_TIME “Hora Oficial de Greenwich”
UTC +01:00 MOROCCO_STANDARD_TIME “Hora Oficial do Marrocos”
UTC +01:00 W_EUROPE_STANDARD_TIME "W. Hora Oficial da Europa Ocidental”
UTC +01:00 CENTRAL_EUROPE_STANDARD_TIME “Hora Oficial da Europa Central”
UTC +01:00 ROMANCE_STANDARD_TIME “Hora Oficial Românica”
UTC +01:00 CENTRAL_EUROPEAN_STANDARD_TIME “Hora Oficial da Europa Central”
UTC +01:00 W_CENTRAL_AFRICA_STANDARD_TIME "W. “Hora Oficial do Centro-oeste da África”
UTC +02:00 NAMIBIA_STANDARD_TIME “Hora Oficial da Namíbia”
UTC +02:00 JORDAN_STANDARD_TIME “Hora Oficial da Jordânia”
UTC +02:00 GTB_STANDARD_TIME “Hora Oficial GTB”
UTC +02:00 MIDDLE_EAST_STANDARD_TIME “Hora Oficial do Oriente Médio”
UTC +02:00 EGYPT_STANDARD_TIME “Hora Oficial do Egito”
UTC +02:00 E_EUROPE_STANDARD_TIME “E. Hora Oficial da Europa Ocidental”
UTC +02:00 SYRIA_STANDARD_TIME “Hora Oficial da Síria”
UTC +02:00 WEST_BANK_STANDARD_TIME “Hora Oficial de West Bank”
UTC +02:00 SOUTH_AFRICA_STANDARD_TIME “Hora Oficial da África do Sul”
UTC +02:00 FLE_STANDARD_TIME “Hora Oficial FLE”
UTC +02:00 ISRAEL_STANDARD_TIME “Hora Oficial de Israel”
UTC +02:00 KALININGRAD_STANDARD_TIME “Hora Oficial de Kaliningrado”
UTC +02:00 LIBYA_STANDARD_TIME “Hora Oficial da Líbia”
UTC +03:00 TÜRKIYE_STANDARD_TIME "Hora Padrão da Turquia"
UTC +03:00 ARABIC_STANDARD_TIME “Hora Oficial Arábica”
UTC +03:00 ARAB_STANDARD_TIME “Hora Oficial Árabe”
UTC +03:00 BELARUS_STANDARD_TIME “Hora Oficial de Belarus”
UTC +03:00 RUSSIAN_STANDARD_TIME “Hora Oficial Russa”
UTC +03:00 E_AFRICA_STANDARD_TIME “E. Hora Oficial do Leste da África”
UTC +03:30 IRAN_STANDARD_TIME “Hora Oficial do Irã”
UTC +04:00 ARABIAN_STANDARD_TIME “Hora Oficial Árabe”
UTC +04:00 ASTRAKHAN_STANDARD_TIME “Hora Oficial de Astrakhan”
UTC +04:00 AZERBAIJAN_STANDARD_TIME “Hora Oficial do Azerbaijão”
UTC +04:00 RUSSIA_TIME_ZONE_3 “Fuso Horário da Rússia 3”
UTC +04:00 MAURITIUS_STANDARD_TIME “Hora Oficial de Maurício”
UTC +04:00 GEORGIAN_STANDARD_TIME “Hora Oficial da Geórgia”
UTC +04:00 CAUCASUS_STANDARD_TIME “Hora Oficial do Cáucaso”
UTC +04:30 AFGHANISTAN_STANDARD_TIME “Hora Oficial do Afeganistão”
UTC +05:00 WEST_ASIA_STANDARD_TIME “Hora Oficial do Oeste da Ásia”
UTC +05:00 EKATERINBURG_STANDARD_TIME “Hora Oficial de Ecaterimburgo”
UTC +05:00 PAKISTAN_STANDARD_TIME “Hora Oficial do Paquistão”
UTC +05:30 INDIA_STANDARD_TIME “Hora Oficial da Índia”
UTC +05:30 SRI_LANKA_STANDARD_TIME “Hora Oficial do Sri Lanka”
UTC +05:45 NEPAL_STANDARD_TIME “Hora Oficial do Nepal”
UTC +06:00 CENTRAL_ASIA_STANDARD_TIME “Hora Oficial da Ásia Central”
UTC +06:00 BANGLADESH_STANDARD_TIME “Hora Oficial de Bangladesh”
UTC +06:30 MYANMAR_STANDARD_TIME “Hora Oficial de Mianmar”
UTC +07:00 N_CENTRAL_ASIA_STANDARD_TIME "N. Hora Oficial do Centro-Norte da Ásia”
UTC +07:00 SE_ASIA_STANDARD_TIME “Hora Oficial do Sudeste da Ásia”
UTC +07:00 ALTAI_STANDARD_TIME “Hora Oficial de Altai”
UTC +07:00 W_MONGOLIA_STANDARD_TIME "W. “Hora Oficial da Mongólia Ocidental”
UTC +07:00 NORTH_ASIA_STANDARD_TIME “Hora Oficial do Norte da Ásia”
UTC +07:00 TOMSK_STANDARD_TIME “Hora Oficial de Tomsk”
UTC +08:00 CHINA_STANDARD_TIME “Hora Oficial da China”
UTC +08:00 NORTH_ASIA_EAST_STANDARD_TIME “Hora Oficial do Nordeste da Ásia”
UTC +08:00 SINGAPORE_STANDARD_TIME “Hora Oficial de Singapura”
UTC +08:00 W_AUSTRALIA_STANDARD_TIME "W. “Hora Oficial da Austrália Central”
UTC +08:00 TAIPEI_STANDARD_TIME “Hora Oficial de Taipé”
UTC +08:00 ULAANBAATAR_STANDARD_TIME “Hora Oficial de Ulan Bator”
UTC +08:45 AUS_CENTRAL_W_STANDARD_TIME “Hora Oficial do Centro-Oeste da Austrália”
UTC +09:00 NORTH_KOREA_STANDARD_TIME “Hora Oficial da Coreia do Norte”
UTC +09:00 TRANSBAIKAL_STANDARD_TIME “Hora Oficial de Transbaikal”
UTC +09:00 TOKYO_STANDARD_TIME “Hora Oficial de Tóquio”
UTC +09:00 KOREA_STANDARD_TIME “Hora Oficial da Coreia do Sul”
UTC +09:00 YAKUTSK_STANDARD_TIME “Hora Oficial de Yakutsk”
UTC +09:30 CEN_AUSTRALIA_STANDARD_TIME "Cen. Hora Oficial da Austrália Central”
UTC +09:30 AUS_CENTRAL_STANDARD_TIME “Hora Oficial da Austrália Central”
UTC +10:00 E_AUSTRALIAN_STANDARD_TIME “E. Hora Oficial da Austrália Central”
UTC +10:00 AUS_EASTERN_STANDARD_TIME “Hora Oficial do Leste da Austrália”
UTC +10:00 WEST_PACIFIC_STANDARD_TIME “Hora Oficial do Oeste do Pacífico”
UTC +10:00 TASMANIA_STANDARD_TIME “Hora Oficial da Tasmânia”
UTC +10:00 VLADIVOSTOK_STANDARD_TIME “Hora Oficial de Vladivostok”
UTC +10:30 LORD_HOWE_STANDARD_TIME “Hora Oficial de Lord Howe”
UTC +11:00 BOUGAINVILLE_STANDARD_TIME “Hora Oficial de Bougainville”
UTC +11:00 RUSSIA_TIME_ZONE_10 “Fuso Horário da Rússia 10”
UTC +11:00 MAGADAN_STANDARD_TIME “Hora Oficial de Magadan”
UTC +11:00 NORFOLK_STANDARD_TIME “Hora Oficial de Norfolk”
UTC +11:00 SAKHALIN_STANDARD_TIME “Hora Oficial de Sakhalin”
UTC +11:00 CENTRAL_PACIFIC_STANDARD_TIME “Hora Oficial do Pacífico Central”
UTC +12:00 RUSSIA_TIME_ZONE_11 “Fuso Horário da Rússia 11”
UTC +12:00 NEW_ZEALAND_STANDARD_TIME “Hora Oficial da Nova Zelândia”
UTC +12:00 UTC_12 "UTC+12"
UTC +12:00 FIJI_STANDARD_TIME “Hora Oficial de Fiji”
UTC +12:00 KAMCHATKA_STANDARD_TIME “Hora Oficial de Kamchatka”
UTC +12:45 CHATHAM_ISLANDS_STANDARD_TIME “Hora Oficial das Ilhas Chatham”
UTC +13:00 TONGA__STANDARD_TIME “Hora Oficial de Tonga”
UTC +13:00 SAMOA_STANDARD_TIME “Hora Oficial de Samoa”
UTC +14:00 LINE_ISLANDS_STANDARD_TIME “Hora Oficial das Ilhas Line”