Schedule Classe

Referência

Define um agendamento para enviar um pipeline.

Depois que um pipeline é publicado, um agendamento pode ser usado para enviá-lo em um intervalo especificado ou quando alterações são detectadas em um local de armazenamento de blobs.

Inicializar Agenda.

Herança: builtins.object

Schedule

Construtor

Schedule(workspace, id, name, description, pipeline_id, status, recurrence, datastore_name, polling_interval, data_path_parameter_name, continue_on_step_failure, path_on_datastore, _schedule_provider=None, pipeline_endpoint_id=None)

Parâmetros

workspace: Workspace

Obrigatório

O objeto de workspace ao qual o agendamento pertencerá.

id: str

Obrigatório

A ID do agendamento.

name: str

Obrigatório

O nome do agendamento.

description: str

Obrigatório

A descrição da agenda.

pipeline_id: str

Obrigatório

A ID do pipeline que o agendamento enviará.

status: str

Obrigatório

O status do agendamento, “Ativo” ou “Desabilitado”.

recurrence: ScheduleRecurrence

Obrigatório

A recorrência do agendamento para o pipeline.

datastore_name: str

Obrigatório

O nome do armazenamento de dados para monitorar blobs modificados/adicionados. Observação: 1) Não há suporte para armazenamentos de dados de VNET. 2) O tipo de autenticação do armazenamento de dados deve ser definido como "Chave de conta".

polling_interval: int

Obrigatório

Por quanto tempo, em minutos, entre a sondagem para blobs modificados/adicionados.

data_path_parameter_name: str

Obrigatório

O nome do parâmetro de pipeline de caminho de dados a ser definido com o caminho de blob alterado.

continue_on_step_failure: bool

Obrigatório

Se deseja continuar a execução de outras etapas no PipelineRun enviado se uma etapa falhar. Se fornecido, substituirá a configuração continue_on_step_failure do pipeline.

path_on_datastore: str

Obrigatório

Opcional. O caminho no armazenamento de dados a ser monitorado para blobs modificados/adicionados. Observação: path_on_datastore estará no contêiner para o armazenamento de dados, portanto, o caminho real que o agendamento monitorará será container/path_on_datastore. Se nenhum, será monitorado o contêiner do armazenamento de dados. Adições/modificações feitas em uma subpasta de path_on_datastore não são monitoradas. Com suporte somente para agendamentos de armazenamento de dados.

_schedule_provider: <xref:azureml.pipeline.core._aeva_provider._AevaScheduleProvider>

valor padrão: None

O provedor de agendamento.

workspace: Workspace

Obrigatório

O objeto de workspace ao qual o agendamento pertencerá.

id: str

Obrigatório

A ID do agendamento.

name: str

Obrigatório

O nome do agendamento.

description: str

Obrigatório

A descrição da agenda.

pipeline_id: str

Obrigatório

A ID do pipeline que o agendamento enviará.

status: str

Obrigatório

O status do agendamento, “Ativo” ou “Desabilitado”.

recurrence: ScheduleRecurrence

Obrigatório

A recorrência do agendamento do pipeline.

datastore_name: str

Obrigatório

O nome do armazenamento de dados para monitorar blobs modificados/adicionados. Observação: não há suporte para armazenamentos de dados de VNet.

polling_interval: int

Obrigatório

Por quanto tempo, em minutos, entre a sondagem para blobs modificados/adicionados.

data_path_parameter_name: str

Obrigatório

O nome do parâmetro de pipeline de caminho de dados a ser definido com o caminho de blob alterado.

continue_on_step_failure: bool

Obrigatório

Se deseja continuar a execução de outras etapas no PipelineRun enviado se uma etapa falhar. Se fornecido, substituirá a configuração continue_on_step_failure do pipeline.

path_on_datastore: str

Obrigatório

_schedule_provider: <xref:azureml.pipeline.core._aeva_provider._AevaScheduleProvider>

Obrigatório

O provedor de agendamento.

pipeline_endpoint_id: str

valor padrão: None

A ID do ponto de extremidade do pipeline que o agendamento enviará.

Comentários

Há suporte para dois tipos de agendamentos. O primeiro usa a recorrência de tempo para enviar um pipeline em um determinado agendamento. O segundo monitora um AzureBlobDatastore quanto a blobs adicionados ou modificados e envia um pipeline quando alterações são detectadas.

Para criar um agendamento que enviará um pipeline em um agendamento recorrente, use ScheduleRecurrence ao criar o agendamento.

Uma ScheduleRecurrence é usada ao criar um Agendamento para um Pipeline da seguinte forma:


   from azureml.pipeline.core import Schedule, ScheduleRecurrence

   recurrence = ScheduleRecurrence(frequency="Hour", interval=12)
   schedule = Schedule.create(workspace, name="TestSchedule", pipeline_id="pipeline_id",
                              experiment_name="helloworld", recurrence=recurrence)

Esse agendamento enviará o PublishedPipeline fornecido a cada 12 horas. O pipeline enviado será criado no experimento com o nome "helloworld".

Para criar um agendamento que disparará PipelineRuns em modificações feitas em um local de armazenamento de blob, especifique um armazenamento de dados e informações de dados relacionadas ao criar o agendamento.


   from azureml.pipeline.core import Schedule
   from azureml.core.datastore import Datastore

   datastore = Datastore(workspace=ws, name="workspaceblobstore")

   schedule = Schedule.create(workspace, name="TestSchedule", pipeline_id="pipeline_id"
                              experiment_name="helloworld", datastore=datastore,
                              polling_interval=5, path_on_datastore="file/path")

Observe que os parâmetros polling_interval e path_on_datastore são opcionais. polling_interval especifica com que frequência sondar modificações no armazenamento de dados e tem como valor, por padrão, cinco minutos. path_on_datastore pode ser usado para especificar em qual pasta no armazenamento de dados monitorar as alterações. Se Nenhum, o contêiner do armazenamento de dados será monitorado. Observação: não são detectadas adições/modificações de blob em subpastas de path_on_datastore ou do contêiner de armazenamento de dados (se path_on_datastore não for especificado).

Além disso, se o pipeline foi criado para usar um DataPath PipelineParameter a fim de descrever uma entrada de etapa, use o parâmetro data_path_parameter_name ao criar um agendamento disparado por armazenamento de dados a fim de definir a entrada para o arquivo alterado quando uma PipelineRun for enviada pelo agendamento.

No exemplo a seguir, quando o agendamento disparar a PipelineRun, o valor de PipelineParameter "input_data" será definido como o arquivo modificado/adicionado:


   from azureml.pipeline.core import Schedule
   from azureml.core.datastore import Datastore

   datastore = Datastore(workspace=ws, name="workspaceblobstore")

   schedule = Schedule.create(workspace, name="TestSchedule", pipeline_id="pipeline_id",
                              experiment_name="helloworld", datastore=datastore,
                              data_path_parameter_name="input_data")

Para saber mais sobre agendamentos, confira: https://aka.ms/pl-schedule.

Métodos

create	Criar um agendamento para um pipeline. Especifique a recorrência de um agendamento baseado em tempo ou especifique um armazenamento de dados, (opcional) polling_interval e (opcional) data_path_parameter_name para criar um agendamento que monitorará o local do armazenamento de dados em busca de modificações/adições.
create_for_pipeline_endpoint	Criar um agendamento para um ponto de extremidade de pipeline. Especifique a recorrência de um agendamento baseado em tempo ou especifique um armazenamento de dados, (opcional) polling_interval e (opcional) data_path_parameter_name para criar um agendamento que monitorará o local do armazenamento de dados em busca de modificações/adições.
disable	Definir o agendamento como "Desabilitado" e não disponível para execução.
enable	Definir o agendamento como "Ativo" e disponível para execução.
get	Obter o agendamento com a ID especificada.
get_all	Obter todos os agendamentos no workspace atual. PRETERIDO: esse método está sendo preterido e substituído pelo método list.
get_last_pipeline_run	Buscar a última execução de pipeline enviada pelo agendamento. Retorna Nenhum se nenhuma das execuções tiver sido enviada.
get_pipeline_runs	Buscar as execuções de pipeline que foram geradas a partir do agendamento.
get_schedules_for_pipeline_endpoint_id	Obter todos os agendamentos de uma determinada ID de ponto de extremidade de pipeline.
get_schedules_for_pipeline_id	Obter todos os agendamentos da ID de pipeline especificada.
list	Obter todos os agendamentos no workspace atual.
load_yaml	Carregar e ler o arquivo YAML para obter os parâmetros de agendamento. O arquivo YAML é mais uma maneira de transmitir parâmetros de agendamento para criar agendamentos.
update	Atualizar o agendamento.

create

Criar um agendamento para um pipeline.

Especifique a recorrência de um agendamento baseado em tempo ou especifique um armazenamento de dados, (opcional) polling_interval e (opcional) data_path_parameter_name para criar um agendamento que monitorará o local do armazenamento de dados em busca de modificações/adições.

static create(workspace, name, pipeline_id, experiment_name, recurrence=None, description=None, pipeline_parameters=None, wait_for_provisioning=False, wait_timeout=3600, datastore=None, polling_interval=5, data_path_parameter_name=None, continue_on_step_failure=None, path_on_datastore=None, _workflow_provider=None, _service_endpoint=None)

Parâmetros

workspace: Workspace

Obrigatório

O objeto de workspace ao qual o agendamento pertencerá.

name: str

Obrigatório

O nome do agendamento.

pipeline_id: str

Obrigatório

A ID do pipeline que o agendamento enviará.

experiment_name: str

Obrigatório

O nome do experimento em que o agendamento enviará execuções.

recurrence: ScheduleRecurrence

valor padrão: None

A recorrência do agendamento do pipeline.

description: str

valor padrão: None

A descrição da agenda.

pipeline_parameters: dict

valor padrão: None

Um dicionário de parâmetros para atribuir novos valores {nome do parâmetro, valor do parâmetro}

wait_for_provisioning: bool

valor padrão: False

Se deve aguardar a conclusão do provisionamento da agenda.

wait_timeout: int

valor padrão: 3600

O número de segundos a aguardar antes de esgotar o tempo limite.

datastore: AzureBlobDatastore

valor padrão: None

O armazenamento de dados para monitorar blobs modificados/adicionados. Observação: não há suporte para armazenamentos de dados de VNet. Não é possível usar com uma recorrência.

polling_interval: int

valor padrão: 5

Por quanto tempo, em minutos, entre a sondagem para blobs modificados/adicionados. O padrão é de 5 minutos. Com suporte somente para agendamentos de armazenamento de dados.

data_path_parameter_name: str

valor padrão: None

O nome do parâmetro de pipeline de caminho de dados a ser definido com o caminho de blob alterado. Com suporte somente para agendamentos de armazenamento de dados.

continue_on_step_failure: bool

valor padrão: None

Se deseja continuar a execução de outras etapas no PipelineRun enviado se uma etapa falhar. Se fornecido, substituirá a configuração continue_on_step_failure do pipeline.

path_on_datastore: str

valor padrão: None

_workflow_provider: <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>

valor padrão: None

O provedor do fluxo de trabalho.

_service_endpoint: str

valor padrão: None

O ponto de extremidade de serviço.

Retornos

O agendamento criado.

Tipo de retorno

Schedule

create_for_pipeline_endpoint

Criar um agendamento para um ponto de extremidade de pipeline.

static create_for_pipeline_endpoint(workspace, name, pipeline_endpoint_id, experiment_name, recurrence=None, description=None, pipeline_parameters=None, wait_for_provisioning=False, wait_timeout=3600, datastore=None, polling_interval=5, data_path_parameter_name=None, continue_on_step_failure=None, path_on_datastore=None, _workflow_provider=None, _service_endpoint=None)

Parâmetros

workspace: Workspace

Obrigatório

O objeto de workspace ao qual o agendamento pertencerá.

name: str

Obrigatório

O nome do agendamento.

pipeline_endpoint_id: str

Obrigatório

A ID do ponto de extremidade do pipeline que o agendamento enviará.

experiment_name: str

Obrigatório

O nome do experimento em que o agendamento enviará execuções.

recurrence: ScheduleRecurrence

valor padrão: None

A recorrência do agendamento do pipeline.

description: str

valor padrão: None

A descrição da agenda.

pipeline_parameters: dict

valor padrão: None

Um dicionário de parâmetros para atribuir novos valores {nome do parâmetro, valor do parâmetro}

wait_for_provisioning: bool

valor padrão: False

Se deve aguardar a conclusão do provisionamento da agenda.

wait_timeout: int

valor padrão: 3600

O número de segundos a aguardar antes de esgotar o tempo limite.

datastore: AzureBlobDatastore

valor padrão: None

O armazenamento de dados para monitorar blobs modificados/adicionados. Observação: não há suporte para armazenamentos de dados de VNet. Não é possível usar com uma recorrência.

polling_interval: int

valor padrão: 5

Por quanto tempo, em minutos, entre a sondagem para blobs modificados/adicionados. O padrão é de 5 minutos. Com suporte somente para agendamentos de armazenamento de dados.

data_path_parameter_name: str

valor padrão: None

O nome do parâmetro de pipeline de caminho de dados a ser definido com o caminho de blob alterado. Com suporte somente para agendamentos de armazenamento de dados.

continue_on_step_failure: bool

valor padrão: None

Se deseja continuar a execução de outras etapas no PipelineRun enviado se uma etapa falhar. Se fornecido, substituirá a configuração continue_on_step_failure do pipeline.

path_on_datastore: str

valor padrão: None

_workflow_provider: <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>

valor padrão: None

O provedor do fluxo de trabalho.

_service_endpoint: str

valor padrão: None

O ponto de extremidade de serviço.

Retornos

O agendamento criado.

Tipo de retorno

Schedule

disable

Definir o agendamento como "Desabilitado" e não disponível para execução.

disable(wait_for_provisioning=False, wait_timeout=3600)

Parâmetros

wait_for_provisioning: bool

valor padrão: False

Se deve aguardar a conclusão do provisionamento da agenda.

wait_timeout: int

valor padrão: 3600

Número de segundos a aguardar antes de esgotar o tempo limite.

enable

Definir o agendamento como "Ativo" e disponível para execução.

enable(wait_for_provisioning=False, wait_timeout=3600)

Parâmetros

wait_for_provisioning: bool

valor padrão: False

Se deve aguardar a conclusão do provisionamento da agenda.

wait_timeout: int

valor padrão: 3600

Número de segundos a aguardar antes de esgotar o tempo limite.

get

Obter o agendamento com a ID especificada.

static get(workspace, id, _workflow_provider=None, _service_endpoint=None)

Parâmetros

workspace: Workspace

Obrigatório

O workspace em que o agendamento foi criado.

id: str

Obrigatório

ID da agenda.

_workflow_provider: <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>

valor padrão: None

O provedor do fluxo de trabalho.

_service_endpoint: str

valor padrão: None

O ponto de extremidade de serviço.

Retornos

Objeto Agendamento

Tipo de retorno

Schedule

get_all

Obter todos os agendamentos no workspace atual.

PRETERIDO: esse método está sendo preterido e substituído pelo método list.

static get_all(workspace, active_only=True, pipeline_id=None, pipeline_endpoint_id=None, _workflow_provider=None, _service_endpoint=None)

Parâmetros

workspace: Workspace

Obrigatório

O workspace.

active_only: bool

valor padrão: True

Se true, retornará somente agendamentos ativos no momento. Aplica-se somente se nenhuma ID de pipeline for fornecida.

pipeline_id: str

valor padrão: None

Se a ID for fornecida, retornará somente agendamentos para o pipeline respectivo.

pipeline_endpoint_id: str

valor padrão: None

Se a ID for fornecida, retornará somente agendamentos para o respectivo ponto de extremidade de pipeline.

_workflow_provider: <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>

valor padrão: None

O provedor do fluxo de trabalho.

_service_endpoint: str

Obter todos os agendamentos de uma determinada ID de ponto de extremidade de pipeline.

static get_schedules_for_pipeline_endpoint_id(workspace, pipeline_endpoint_id, _workflow_provider=None, _service_endpoint=None)

Parâmetros

workspace: Workspace

Obrigatório

O workspace.

pipeline_endpoint_id: str

Obrigatório

A ID do ponto de extremidade do pipeline.

_workflow_provider: <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>

valor padrão: None

O provedor do fluxo de trabalho.

_service_endpoint: str

valor padrão: None

O ponto de extremidade de serviço.

Retornos

Uma lista de Schedule.

Tipo de retorno

list

get_schedules_for_pipeline_id

Obter todos os agendamentos da ID de pipeline especificada.

static get_schedules_for_pipeline_id(workspace, pipeline_id, _workflow_provider=None, _service_endpoint=None)

Parâmetros

workspace: Workspace

Obrigatório

O workspace.

pipeline_id: str

Obrigatório

A ID do pipeline.

_workflow_provider: <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>

valor padrão: None

O provedor do fluxo de trabalho.

_service_endpoint: str

valor padrão: None

O ponto de extremidade de serviço.

Retornos

Uma lista de Schedule.

Tipo de retorno

list

Obter todos os agendamentos no workspace atual.

static list(workspace, active_only=True, pipeline_id=None, pipeline_endpoint_id=None, _workflow_provider=None, _service_endpoint=None)

Parâmetros

workspace: Workspace

Obrigatório

O workspace.

active_only: bool

valor padrão: True

Se true, retornará somente agendamentos ativos no momento. Aplica-se somente se nenhuma ID de pipeline for fornecida.

pipeline_id: str

valor padrão: None

Se a ID for fornecida, retornará somente agendamentos para o pipeline respectivo.

pipeline_endpoint_id: str

valor padrão: None

Se a ID for fornecida, retornará somente agendamentos para o respectivo ponto de extremidade de pipeline.

_workflow_provider: <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>

valor padrão: None

O provedor do fluxo de trabalho.

_service_endpoint: str

valor padrão: None

O ponto de extremidade de serviço.

Retornos

Uma lista de Schedule.

Tipo de retorno

list

load_yaml

Carregar e ler o arquivo YAML para obter os parâmetros de agendamento.

O arquivo YAML é mais uma maneira de transmitir parâmetros de agendamento para criar agendamentos.

static load_yaml(workspace, filename, _workflow_provider=None, _service_endpoint=None)

Parâmetros

workspace: Workspace

Obrigatório

O workspace.

filename: str

Obrigatório

O nome de arquivo YAML com local.

_workflow_provider: <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>

valor padrão: None

O provedor do fluxo de trabalho.

_service_endpoint: str

valor padrão: None

O ponto de extremidade de serviço.

Retornos

Um dicionário de parâmetros e valores de Schedule.

Tipo de retorno

dict

Comentários

Há suporte para dois tipos de YAML nos agendamentos. O primeiro lê e carrega informações de recorrência para a criação de agendamento a fim de disparar o pipeline. O segundo lê e carrega informações de armazenamento de dados para a criação de agendamento a fim de disparar o pipeline.

Exemplo de criação de um agendamento que enviará um pipeline em uma recorrência, da seguinte forma:


   from azureml.pipeline.core import Schedule

   schedule_info = Schedule.load_yaml(workspace=workspace,
                                      filename='./yaml/test_schedule_with_recurrence.yaml')
   schedule = Schedule.create(workspace, name="TestSchedule", pipeline_id="pipeline_id",
                              experiment_name="helloworld", recurrence=schedule_info.get("recurrence"),
                              description=schedule_info.get("description"))

Arquivo YAML de exemplo test_schedule_with_recurrence.yaml:


   Schedule:
       description: "Test create with recurrence"
       recurrence:
           frequency: Week # Can be "Minute", "Hour", "Day", "Week", or "Month".
           interval: 1 # how often fires
           start_time: 2019-06-07T10:50:00
           time_zone: UTC
           hours:
           - 1
           minutes:
           - 0
           time_of_day: null
           week_days:
           - Friday
       pipeline_parameters: {'a':1}
       wait_for_provisioning: True
       wait_timeout: 3600
       datastore_name: ~
       polling_interval: ~
       data_path_parameter_name: ~
       continue_on_step_failure: None
       path_on_datastore: ~

Exemplo de criação de um agendamento que enviará um pipeline em um armazenamento de dados, da seguinte forma:


   from azureml.pipeline.core import Schedule

   schedule_info = Schedule.load_yaml(workspace=workspace,
                                      filename='./yaml/test_schedule_with_datastore.yaml')
   schedule = Schedule.create(workspace, name="TestSchedule", pipeline_id="pipeline_id",
                              experiment_name="helloworld",datastore=schedule_info.get("datastore_name"),
                              polling_interval=schedule_info.get("polling_interval"),
                              data_path_parameter_name=schedule_info.get("data_path_parameter_name"),
                              continue_on_step_failure=schedule_info.get("continue_on_step_failure"),
                              path_on_datastore=schedule_info.get("path_on_datastore"))

update

Atualizar o agendamento.

update(name=None, description=None, recurrence=None, pipeline_parameters=None, status=None, wait_for_provisioning=False, wait_timeout=3600, datastore=None, polling_interval=None, data_path_parameter_name=None, continue_on_step_failure=None, path_on_datastore=None)

Parâmetros

name: str

valor padrão: None

O novo nome do agendamento.

recurrence: ScheduleRecurrence

valor padrão: None

A nova recorrência de agendamento do pipeline.

description: str

valor padrão: None

A nova descrição do agendamento.

pipeline_parameters: dict

valor padrão: None

Um dicionário de parâmetros para atribuir novos valores {nome do parâmetro, valor do parâmetro}.

status: str

valor padrão: None

O novo status do agendamento, “Ativo” ou “Desabilitado”.

wait_for_provisioning: bool

valor padrão: False

Se deve aguardar a conclusão do provisionamento da agenda.

wait_timeout: int

valor padrão: 3600

O número de segundos a aguardar antes de esgotar o tempo limite.

datastore: AzureBlobDatastore

valor padrão: None

O armazenamento de dados para monitorar blobs modificados/adicionados. Observação: não há suporte para armazenamentos de dados de VNet.

polling_interval: int

valor padrão: None

Por quanto tempo, em minutos, entre a sondagem para blobs modificados/adicionados. O padrão é de 5 minutos.

data_path_parameter_name: str

valor padrão: None

O nome do parâmetro de pipeline de caminho de dados a ser definido com o caminho de blob alterado.

continue_on_step_failure: bool

valor padrão: None

Se deseja continuar a execução de outras etapas no PipelineRun enviado se uma etapa falhar. Se fornecido, substituirá a configuração continue_on_step_failure do pipeline.

path_on_datastore: str

valor padrão: None

str