Schedule Třída
Definuje plán, podle kterého se má kanál odeslat.
Po publikování kanálu je možné použít plán k odeslání kanálu v zadaném intervalu nebo při zjištění změn v umístění úložiště objektů blob.
Inicializujte plán.
- Dědičnost
-
builtins.objectSchedule
Konstruktor
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)Parametry
- datastore_name
- str
Název úložiště dat, které má monitorovat upravené nebo přidané objekty blob. Poznámka: 1) Úložiště dat virtuální sítě se nepodporují. 2) Typ ověřování pro úložiště dat by měl být nastavený na klíč účtu.
- polling_interval
- int
Jak dlouho (v minutách) mezi dotazováním na upravené/přidané objekty blob
- data_path_parameter_name
- str
Název parametru kanálu cesty k datům, který se má nastavit se změněnou cestou objektu blob.
- continue_on_step_failure
- bool
Jestli chcete pokračovat v provádění dalších kroků v odeslaném kanáluSpustit, pokud se krok nezdaří. Pokud je zadaný, přepíše se tím nastavení continue_on_step_failure pro kanál.
- path_on_datastore
- str
Nepovinný parametr. Cesta k úložišti dat pro monitorování upravených nebo přidaných objektů blob. Poznámka: path_on_datastore bude v kontejneru úložiště dat, takže skutečná cesta, kterou bude plán monitorovat, bude kontejner/path_on_datastore. Pokud žádný není, kontejner úložiště dat se monitoruje. Doplňky nebo úpravy provedené v podsložce path_on_datastore nejsou monitorovány. Podporováno pouze pro plány úložiště dat.
- _schedule_provider
- <xref:azureml.pipeline.core._aeva_provider._AevaScheduleProvider>
Poskytovatel plánu.
- datastore_name
- str
Název úložiště dat, které má monitorovat upravené nebo přidané objekty blob. Poznámka: Úložiště dat virtuální sítě se nepodporují.
- polling_interval
- int
Jak dlouho (v minutách) mezi dotazováním na upravené/přidané objekty blob
- data_path_parameter_name
- str
Název parametru kanálu cesty k datům, který se má nastavit se změněnou cestou objektu blob.
- continue_on_step_failure
- bool
Jestli chcete pokračovat v provádění dalších kroků v odeslaném kanáluSpustit, pokud se krok nezdaří. Pokud je zadaný, přepíše se tím nastavení continue_on_step_failure pro kanál.
- path_on_datastore
- str
Nepovinný parametr. Cesta k úložišti dat pro monitorování upravených nebo přidaných objektů blob. Poznámka: path_on_datastore bude v kontejneru úložiště dat, takže skutečná cesta, kterou bude plán monitorovat, bude kontejner/path_on_datastore. Pokud žádný není, kontejner úložiště dat se monitoruje. Doplňky nebo úpravy provedené v podsložce path_on_datastore nejsou monitorovány. Podporováno pouze pro plány úložiště dat.
- _schedule_provider
- <xref:azureml.pipeline.core._aeva_provider._AevaScheduleProvider>
Poskytovatel plánu.
Poznámky
Podporují se dva typy plánů. První používá časové opakování k odeslání kanálu podle daného plánu. Druhý monitoruje AzureBlobDatastore přidané nebo upravené objekty blob a při zjištění změn odešle kanál.
Pokud chcete vytvořit plán, který odešle kanál podle opakovaného plánu, při vytváření plánu použijte ScheduleRecurrence .
ScheduleRecurrence se používá při vytváření plánu pro kanál následujícím způsobem:
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)
Tento plán bude odesílat poskytnuté údaje PublishedPipeline každých 12 hodin. Odeslaný kanál se vytvoří v rámci experimentu s názvem "helloworld".
Pokud chcete vytvořit plán, který aktivuje spuštění kanálu při úpravách umístění úložiště objektů blob, při vytváření plánu zadejte úložiště dat a související informace o datech.
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")
Všimněte si, že parametry polling_interval a path_on_datastore jsou volitelné. Polling_interval určuje, jak často se má dotazovat na změny úložiště dat, a ve výchozím nastavení je to 5 minut. path_on_datastore lze použít k určení složky v úložišti dat, která se má monitorovat z závislosti na změnách. Pokud žádný, kontejner úložiště dat se monitoruje. Poznámka: Nezjistí se přidání nebo úpravy objektů blob v podsložkách path_on_datastore nebo kontejneru úložiště dat (pokud není zadána žádná path_on_datastore).
Pokud byl navíc kanál vytvořen tak, aby popisoval DataPathPipelineParameter krokový vstup, použijte při vytváření plánu aktivovaného úložištěm dat parametr data_path_parameter_name a nastavte vstup na změněný soubor, když plán odešle spuštění kanálu.
Když v následujícím příkladu Schedule aktivuje spuštění kanálu, hodnota "input_data" PipelineParameter se nastaví jako soubor, který byl změněn nebo přidán:
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")
Další informace o plánech najdete tady: https://aka.ms/pl-schedule.
Metody
| create |
Vytvořte plán pro kanál. Zadejte opakování pro časový plán nebo zadejte úložiště dat, (volitelné) polling_interval a (volitelné) data_path_parameter_name a vytvořte plán, který bude monitorovat změny nebo přidání v umístění úložiště dat. |
| create_for_pipeline_endpoint |
Vytvořte plán pro koncový bod kanálu. Zadejte opakování pro časový plán nebo zadejte úložiště dat, (volitelné) polling_interval a (volitelné) data_path_parameter_name a vytvořte plán, který bude monitorovat změny nebo přidání v umístění úložiště dat. |
| disable |
Nastavte plán na Zakázáno a není k dispozici ke spuštění. |
| enable |
Nastavte plán na Aktivní a k dispozici ke spuštění. |
| get |
Získejte plán s daným ID. |
| get_all |
Získejte všechny plány v aktuálním pracovním prostoru. ZASTARALÉ: Tato metoda je zastaralá ve prospěch list metody . |
| get_last_pipeline_run |
Načte poslední spuštění kanálu odeslané podle plánu. Pokud nebyla odeslána žádná spuštění, vrátí hodnotu Žádné. |
| get_pipeline_runs |
Načtěte spuštění kanálu, která se vygenerovala z plánu. |
| get_schedules_for_pipeline_endpoint_id |
Získejte všechny plány pro dané ID koncového bodu kanálu. |
| get_schedules_for_pipeline_id |
Získejte všechny plány pro dané ID kanálu. |
| list |
Získejte všechny plány v aktuálním pracovním prostoru. |
| load_yaml |
Načtěte a načtěte soubor YAML, abyste získali parametry plánu. Soubor YAML je dalším způsobem, jak předat parametry plánu k vytvoření plánu. |
| update |
Aktualizujte plán. |
create
Vytvořte plán pro kanál.
Zadejte opakování pro časový plán nebo zadejte úložiště dat, (volitelné) polling_interval a (volitelné) data_path_parameter_name a vytvořte plán, který bude monitorovat změny nebo přidání v umístění úložiště dat.
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)Parametry
- pipeline_parameters
- dict
Slovník parametrů pro přiřazení nových hodnot {název_parametru, hodnota_parametru}
- datastore
- AzureBlobDatastore
Úložiště dat, které má monitorovat upravené nebo přidané objekty blob. Poznámka: Úložiště dat virtuální sítě se nepodporují. Nelze použít s opakováním.
- polling_interval
- int
Jak dlouho (v minutách) mezi dotazováním na upravené/přidané objekty blob Výchozí hodnota je 5 minut. Podporováno pouze pro plány úložiště dat.
- data_path_parameter_name
- str
Název parametru kanálu cesty k datům, který se má nastavit se změněnou cestou objektu blob. Podporováno pouze pro plány úložiště dat.
- continue_on_step_failure
- bool
Jestli chcete pokračovat v provádění dalších kroků v odeslaném kanáluSpustit, pokud se krok nezdaří. Pokud je zadaný, přepíše se tím nastavení continue_on_step_failure pro kanál.
- path_on_datastore
- str
Nepovinný parametr. Cesta k úložišti dat pro monitorování upravených nebo přidaných objektů blob. Poznámka: path_on_datastore bude v kontejneru úložiště dat, takže skutečná cesta, kterou bude plán monitorovat, bude kontejner/path_on_datastore. Pokud žádný není, kontejner úložiště dat se monitoruje. Doplňky nebo úpravy provedené v podsložce path_on_datastore nejsou monitorovány. Podporováno pouze pro plány úložiště dat.
- _workflow_provider
- <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
Zprostředkovatel pracovního postupu.
Návraty
Vytvořený plán.
Návratový typ
create_for_pipeline_endpoint
Vytvořte plán pro koncový bod kanálu.
Zadejte opakování pro časový plán nebo zadejte úložiště dat, (volitelné) polling_interval a (volitelné) data_path_parameter_name a vytvořte plán, který bude monitorovat změny nebo přidání v umístění úložiště dat.
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)Parametry
- pipeline_parameters
- dict
Slovník parametrů pro přiřazení nových hodnot {název_parametru, hodnota_parametru}
- datastore
- AzureBlobDatastore
Úložiště dat, které má monitorovat upravené nebo přidané objekty blob. Poznámka: Úložiště dat virtuální sítě se nepodporují. Nelze použít s opakováním.
- polling_interval
- int
Jak dlouho (v minutách) mezi dotazováním na upravené/přidané objekty blob Výchozí hodnota je 5 minut. Podporováno pouze pro plány úložiště dat.
- data_path_parameter_name
- str
Název parametru kanálu cesty k datům, který se má nastavit se změněnou cestou objektu blob. Podporováno pouze pro plány úložiště dat.
- continue_on_step_failure
- bool
Jestli chcete pokračovat v provádění dalších kroků v odeslaném kanáluSpustit, pokud se krok nezdaří. Pokud je zadaný, přepíše se tím nastavení continue_on_step_failure pro kanál.
- path_on_datastore
- str
Nepovinný parametr. Cesta k úložišti dat pro monitorování upravených nebo přidaných objektů blob. Poznámka: path_on_datastore bude v kontejneru úložiště dat, takže skutečná cesta, kterou bude plán monitorovat, bude kontejner/path_on_datastore. Pokud žádný není, kontejner úložiště dat se monitoruje. Doplňky nebo úpravy provedené v podsložce path_on_datastore nejsou monitorovány. Podporováno pouze pro plány úložiště dat.
- _workflow_provider
- <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
Zprostředkovatel pracovního postupu.
Návraty
Vytvořený plán.
Návratový typ
disable
Nastavte plán na Zakázáno a není k dispozici ke spuštění.
disable(wait_for_provisioning=False, wait_timeout=3600)Parametry
enable
Nastavte plán na Aktivní a k dispozici ke spuštění.
enable(wait_for_provisioning=False, wait_timeout=3600)Parametry
get
Získejte plán s daným ID.
static get(workspace, id, _workflow_provider=None, _service_endpoint=None)Parametry
- _workflow_provider
- <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
Zprostředkovatel pracovního postupu.
Návraty
Objekt plánu
Návratový typ
get_all
Získejte všechny plány v aktuálním pracovním prostoru.
ZASTARALÉ: Tato metoda je zastaralá ve prospěch list metody .
static get_all(workspace, active_only=True, pipeline_id=None, pipeline_endpoint_id=None, _workflow_provider=None, _service_endpoint=None)Parametry
- active_only
- bool
Pokud je hodnota true, vrátí se pouze plány, které jsou aktuálně aktivní. Platí jenom v případě, že se nezadá id kanálu.
- pipeline_endpoint_id
- str
Pokud ho zadáte, vrátí se pouze plány pro koncový bod kanálu s daným ID.
- _workflow_provider
- <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
Zprostředkovatel pracovního postupu.
Návraty
Seznam .Schedule
Návratový typ
get_last_pipeline_run
Načte poslední spuštění kanálu odeslané podle plánu. Pokud nebyla odeslána žádná spuštění, vrátí hodnotu Žádné.
get_last_pipeline_run()Návraty
Poslední spuštění kanálu
Návratový typ
get_pipeline_runs
Načtěte spuštění kanálu, která se vygenerovala z plánu.
get_pipeline_runs()Návraty
Seznam .PipelineRun
Návratový typ
get_schedules_for_pipeline_endpoint_id
Získejte všechny plány pro dané ID koncového bodu kanálu.
static get_schedules_for_pipeline_endpoint_id(workspace, pipeline_endpoint_id, _workflow_provider=None, _service_endpoint=None)Parametry
- _workflow_provider
- <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
Zprostředkovatel pracovního postupu.
Návraty
Seznam .Schedule
Návratový typ
get_schedules_for_pipeline_id
Získejte všechny plány pro dané ID kanálu.
static get_schedules_for_pipeline_id(workspace, pipeline_id, _workflow_provider=None, _service_endpoint=None)Parametry
- _workflow_provider
- <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
Zprostředkovatel pracovního postupu.
Návraty
Seznam .Schedule
Návratový typ
list
Získejte všechny plány v aktuálním pracovním prostoru.
static list(workspace, active_only=True, pipeline_id=None, pipeline_endpoint_id=None, _workflow_provider=None, _service_endpoint=None)Parametry
- active_only
- bool
Pokud je hodnota true, vrátí se pouze plány, které jsou aktuálně aktivní. Platí jenom v případě, že se nezadá id kanálu.
- pipeline_endpoint_id
- str
Pokud ho zadáte, vrátí se pouze plány pro koncový bod kanálu s daným ID.
- _workflow_provider
- <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
Zprostředkovatel pracovního postupu.
Návraty
Seznam .Schedule
Návratový typ
load_yaml
Načtěte a načtěte soubor YAML, abyste získali parametry plánu.
Soubor YAML je dalším způsobem, jak předat parametry plánu k vytvoření plánu.
static load_yaml(workspace, filename, _workflow_provider=None, _service_endpoint=None)Parametry
- _workflow_provider
- <xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
Zprostředkovatel pracovního postupu.
Návraty
Slovník Schedule parametrů a hodnot.
Návratový typ
Poznámky
Plány podporují dva typy YAML. První přečte a načte informace o opakování pro vytvoření plánu pro aktivaci kanálu. Druhý načte a načte informace o úložišti dat pro vytvoření plánu, který aktivuje kanál.
Příklad vytvoření plánu, který odešle kanál při opakování, a to následujícím způsobem:
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"))
Ukázkový soubor YAML 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: ~
Příklad vytvoření plánu, který odešle kanál do úložiště dat, je následující:
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
Aktualizujte plán.
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)Parametry
- pipeline_parameters
- dict
Slovník parametrů pro přiřazení nových hodnot {název_parametru, hodnota_parametru}.
- datastore
- AzureBlobDatastore
Úložiště dat, které má monitorovat upravené nebo přidané objekty blob. Poznámka: Úložiště dat virtuální sítě se nepodporují.
- polling_interval
- int
Jak dlouho (v minutách) mezi dotazováním na upravené/přidané objekty blob Výchozí hodnota je 5 minut.
- data_path_parameter_name
- str
Název parametru kanálu cesty k datům, který se má nastavit se změněnou cestou objektu blob.
- continue_on_step_failure
- bool
Jestli chcete pokračovat v provádění dalších kroků v odeslaném kanáluSpustit, pokud se krok nezdaří. Pokud je zadaný, přepíše se tím nastavení continue_on_step_failure pro kanál.
- path_on_datastore
- str
Nepovinný parametr. Cesta k úložišti dat pro monitorování upravených nebo přidaných objektů blob. Poznámka: path_on_datastore bude v kontejneru úložiště dat, takže skutečná cesta, kterou bude plán monitorovat, bude kontejner/path_on_datastore. Pokud žádný není, kontejner úložiště dat se monitoruje. Doplňky nebo úpravy provedené v podsložce path_on_datastore nejsou monitorovány. Podporováno pouze pro plány úložiště dat.
Atributy
continue_on_step_failure
Získá hodnotu continue_on_step_failure nastavení.
Návraty
Hodnota continue_on_step_failure nastavení
Návratový typ
data_path_parameter_name
Získejte název parametru kanálu cesty k datům, který se má nastavit se změněnou cestou objektu blob.
Návraty
Název parametru cesty k datům.
Návratový typ
datastore_name
description
id
name
path_on_datastore
Získejte cestu k úložišti dat, které plán monitoruje.
Návraty
Cesta k úložišti dat.
Návratový typ
pipeline_endpoint_id
pipeline_id
polling_interval
Zjistěte, jak dlouho v minutách mezi dotazováním na upravené nebo přidané objekty blob.
Návraty
Interval dotazování.
Návratový typ
recurrence
status
Váš názor
Připravujeme: V průběhu roku 2024 budeme postupně vyřazovat problémy z GitHub coby mechanismus zpětné vazby pro obsah a nahrazovat ho novým systémem zpětné vazby. Další informace naleznete v tématu: https://aka.ms/ContentUserFeedback.
Odeslat a zobrazit názory pro