PipelineDraft Klasa

Odwołanie

Reprezentuje potok modyfikowalny, który może służyć do przesyłania przebiegów i tworzenia opublikowanych potoków.

Użyj usługi PipelineDrafts, aby iterować potoki. Potoki można utworzyć od podstaw, innego potoku PipelineDraft lub istniejących potoków: Pipeline, PublishedPipelinelub PipelineRun.

Inicjowanie potokuDraft.

Dziedziczenie: builtins.object

PipelineDraft

Konstruktor

PipelineDraft(workspace, id, name=None, description=None, experiment_name=None, tags=None, properties=None, graph_draft_id=None, parent_pipeline_id=None, parent_pipeline_run_id=None, parent_step_run_ids=None, parent_pipeline_draft_id=None, last_submitted_pipeline_run_id=None, _pipeline_draft_provider=None)

Parametry

Nazwa	Opis
workspace Wymagane	Workspace Obiekt obszaru roboczego dla tego potokuDraft.
id Wymagane	str Identyfikator elementu PipelineDraft.
name Wymagane	str Nazwa potoku PipelineDraft.
description Wymagane	str Opis elementu PipelineDraft.
experiment_name Wymagane	str Nazwa eksperymentu dla elementu PipelineDraft.
tags Wymagane	Dict[str, str] Opcjonalny słownik tagów dla elementu PipelineDraft.
properties Wymagane	Dict[str, str] Opcjonalny słownik właściwości dla elementu PipelineDraft.
graph_draft_id Wymagane	str Identyfikator projektu grafu skojarzonego z potokiemDraft.
parent_pipeline_id Wymagane	str Identyfikator nadrzędnego elementu PublishedPipeline.
parent_pipeline_run_id Wymagane	str Identyfikator nadrzędnego potokuRun.
parent_step_run_ids Wymagane	list Lista identyfikatorów StepRun nadrzędnego potoku.
parent_pipeline_draft_id Wymagane	str Identyfikator nadrzędnego elementu PipelineDraft.
last_submitted_pipeline_run_id Wymagane	str Identyfikator ostatniego przesłanego elementu PipelineRun.
_pipeline_draft_provider Wymagane	<xref:azureml.pipeline.core._aeva_provider._AevaPipelineDraftProvider> (Tylko użycie wewnętrzne). Dostawca PipelineDraft.
workspace Wymagane	Workspace Obiekt obszaru roboczego dla tego potokuDraft.
id Wymagane	str Identyfikator potoku PipelineDraft.
name Wymagane	str Nazwa potoku PipelineDraft.
description Wymagane	str Opis elementu PipelineDraft.
experiment_name Wymagane	str Nazwa eksperymentu dla elementu PipelineDraft.
tags Wymagane	Dict[str, str] Słownik tagów dla potokuDraft.
properties Wymagane	Dict[str, str] Słownik właściwości dla elementu PipelineDraft.
graph_draft_id Wymagane	str Identyfikator projektu grafu skojarzonego z potokiemDraft.
parent_pipeline_id Wymagane	str Identyfikator nadrzędnego elementu PublishedPipeline.
parent_pipeline_run_id Wymagane	str Identyfikator nadrzędnego potokuRun.
parent_step_run_ids Wymagane	list Lista identyfikatorów StepRun nadrzędnego potoku.
parent_pipeline_draft_id Wymagane	str Identyfikator nadrzędnego elementu PipelineDraft.
last_submitted_pipeline_run_id Wymagane	str Identyfikator ostatniego przesłanego elementu PipelineRun.
_pipeline_draft_provider Wymagane	<xref:azureml.pipeline.core._aeva_provider._AevaPipelineDraftProvider> Dostawca PipelineDraft.

Uwagi

PotokDraft można utworzyć na podstawie Pipeline elementu przy użyciu create funkcji . Poniżej przedstawiono przykład:


   from azureml.pipeline.core import Pipeline, PipelineDraft
   from azureml.pipeline.steps import PythonScriptStep

   train_step = PythonScriptStep(name="Training_Step",
                                 script_name="train.py",
                                 compute_target=aml_compute_target,
                                 source_directory=".")
   pipeline = Pipeline(workspace=ws, steps=[train_step])
   pipeline_draft = PipelineDraft.create(workspace=ws,
                                         name="TestPipelineDraft",
                                         description="draft description",
                                         experiment_name="helloworld",
                                         pipeline=pipeline,
                                         continue_on_step_failure=True,
                                         tags={'dev': 'true'},
                                         properties={'train': 'value'})

Parametr potoku PipelineDraft.create() może być również parametrem PublishedPipeline, PipelineRunlub innym PipelineDraft.

Aby przesłać przebieg z elementu PipelineDraft, użyj submit_run metody :


   pipeline_run = pipeline_draft.submit_run()

Aby zaktualizować metodę PipelineDraft update . Funkcja update() projektu potoku może służyć do aktualizowania nazwy, opisu, nazwy eksperymentu, przypisań parametrów potoku, kontynuowania ustawienia niepowodzenia kroku i potoku skojarzonego z potokiemDraft.


   new_train_step = PythonScriptStep(name="New_Training_Step",
                                     script_name="train.py",
                                     compute_target=aml_compute_target,
                                     source_directory=source_directory)

   new_pipeline = Pipeline(workspace=ws, steps=[new_train_step])

   pipeline_draft.update(name="UpdatedPipelineDraft",
                         description="has updated train step",
                         pipeline=new_pipeline)

Metody

create	Utwórz element PipelineDraft.
delete	Usuń element PipelineDraft.
get	Pobierz ciąg PipelineDraft z podanym identyfikatorem.
get_graph	Pobierz wykres skojarzony z elementem PipelineDraft.
list	Pobierz wszystkie wersje robocze potoku w obszarze roboczym.
publish	Publikowanie elementu PublishedPipeline z elementu PipelineDraft.
save	Zapisz plik YAML PipelineDraft.
submit_run	Prześlij przebieg potoku z potokuDraft.
update	Zaktualizuj element PipelineDraft. Podane pola zostaną zaktualizowane.

create

Utwórz element PipelineDraft.

static create(workspace, pipeline, name=None, description=None, experiment_name=None, pipeline_parameters=None, continue_on_step_failure=None, tags=None, properties=None, _workflow_provider=None, _service_endpoint=None)

Parametry

Nazwa	Opis
workspace Wymagane	Workspace Obiekt obszaru roboczego, do którego będzie należeć ten element PipelineDraft.
pipeline Wymagane	PublishedPipeline lub Pipeline lub PipelineRun lub PipelineDraft Opublikowany potok lub potok.
name	str Nazwa elementu PipelineDraft; wymagane tylko podczas tworzenia na podstawie elementu Pipeline. Domyślna wartość: None
description	str Opis elementu PipelineDraft; wymagane tylko podczas tworzenia na podstawie elementu Pipeline. Domyślna wartość: None
experiment_name	str Nazwa eksperymentu dla elementu PipelineDraft; wymagane tylko podczas tworzenia na podstawie elementu Pipeline. Domyślna wartość: None
pipeline_parameters	Dict[str, str] Opcjonalny słownik przypisań parametrów potoku dla potokuDraft; wymagane tylko podczas tworzenia na podstawie elementu Pipeline. Domyślna wartość: None
continue_on_step_failure	bool Wskazuje, czy kontynuować przebieg potoku, gdy uruchomienie kroku kończy się niepowodzeniem dla potokuDraft; wymagane tylko podczas tworzenia na podstawie elementu Pipeline. Domyślna wartość: None
tags	Dict[str, str] Opcjonalny słownik tagów dla potoku PipelineDraft jest potrzebny tylko podczas tworzenia na podstawie elementu Pipeline. Domyślna wartość: None
properties	Dict[str, str] Opcjonalny słownik właściwości dla elementu PipelineDraft, wymagany tylko podczas tworzenia na podstawie elementu Pipeline. Domyślna wartość: None
_service_endpoint	str Punkt końcowy usługi. Domyślna wartość: None
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> (Tylko użycie wewnętrzne). Dostawca przepływu pracy. Domyślna wartość: None

Zwraca

Typ	Opis
PipelineDraft	Utworzony ciąg PipelineDraft.

delete

Usuń element PipelineDraft.

delete(_workflow_provider=None)

Parametry

Nazwa	Opis
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> (Tylko użycie wewnętrzne). Dostawca przepływu pracy. Domyślna wartość: None

get

Pobierz ciąg PipelineDraft z podanym identyfikatorem.

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

Parametry

Nazwa	Opis
workspace Wymagane	Workspace Obszar roboczy, w ramach którego utworzono element PipelineDraft.
id Wymagane	str Identyfikator elementu PipelineDraft.
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> (Tylko użycie wewnętrzne). Dostawca przepływu pracy. Domyślna wartość: None
_service_endpoint	str Punkt końcowy usługi. Domyślna wartość: None

Zwraca

Typ	Opis
PipelineDraft	PipelineDraft, obiekt

get_graph

Pobierz wykres skojarzony z elementem PipelineDraft.

get_graph(_workflow_provider=None)

Parametry

Nazwa	Opis
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> (Tylko użycie wewnętrzne). Dostawca przepływu pracy. Domyślna wartość: None

Zwraca

Typ	Opis
Graph	Obiekt Graph.

list

Pobierz wszystkie wersje robocze potoku w obszarze roboczym.

static list(workspace, tags=None, _workflow_provider=None)

Parametry

Nazwa	Opis
workspace Wymagane	Workspace Obszar roboczy, z którego mają być wyświetlone wersje robocze.
tags	dict Jeśli zostanie określony, zwraca wersje robocze zgodne z określonym {"tag": "value"}. Domyślna wartość: None
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> (Tylko użycie wewnętrzne). Dostawca przepływu pracy. Domyślna wartość: None

Zwraca

Typ	Opis
list	Lista PipelineDraft obiektów.

publish

Publikowanie elementu PublishedPipeline z elementu PipelineDraft.

publish(_workflow_provider=None)

Parametry

Nazwa	Opis
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> (Tylko użycie wewnętrzne). Dostawca przepływu pracy. Domyślna wartość: None

Zwraca

Typ	Opis
PublishedPipeline	Utworzony element PublishedPipeline.

save

Zapisz plik YAML PipelineDraft.

save(path=None, _workflow_provider=None)

Parametry

Nazwa	Opis
path	str Ścieżka do zapisania kodu YAML. Jeśli ścieżka jest katalogiem, plik PipelineDraft YAML jest zapisywany w pliku path/pipeline_name.yml. Jeśli ścieżka to Brak, używany jest bieżący katalog. Domyślna wartość: None
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> (Tylko użycie wewnętrzne). Dostawca przepływu pracy. Domyślna wartość: None

Zwraca

Typ	Opis
None

submit_run

Prześlij przebieg potoku z potokuDraft.

submit_run(_workflow_provider=None)

Parametry

Nazwa	Opis
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> (Tylko użycie wewnętrzne). Dostawca przepływu pracy. Domyślna wartość: None

Zwraca

Typ	Opis
PipelineRun	Przesłany ciąg PipelineRun.

update

Zaktualizuj element PipelineDraft.

Podane pola zostaną zaktualizowane.

update(pipeline=None, name=None, description=None, experiment_name=None, tags=None, pipeline_parameters=None, continue_on_step_failure=None, _workflow_provider=None)

Parametry

Nazwa	Opis
pipeline	Pipeline Zaktualizowany potok dla wersji roboczej. Domyślna wartość: None
name	str Nazwa potoku PipelineDraft. Domyślna wartość: None
description	str Opis elementu PipelineDraft. Domyślna wartość: None
experiment_name	str Nazwa eksperymentu dla elementu PipelineDraft. Domyślna wartość: None
tags	Dict[str, str] Słownik tagów dla potoku PipelineDraft. Domyślna wartość: None
pipeline_parameters	Dict[str, str] Przypisania parametrów potoku dla potokuDraft. Domyślna wartość: None
continue_on_step_failure	bool Czy kontynuować przebieg potoku, gdy uruchomienie kroku kończy się niepowodzeniem dla potokuDraft. Domyślna wartość: None
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> (Tylko użycie wewnętrzne). Dostawca przepływu pracy. Domyślna wartość: None

Atrybuty

description

Pobierz opis elementu PipelineDraft.

Zwraca

Typ	Opis
str	Ciąg opisu.

id

Pobierz identyfikator potokuDraft.

Zwraca

Typ	Opis
str	Identyfikator.

last_submitted_pipeline_run_id

Pobierz identyfikator ostatniego przesłanego potokuUruchom pipelineDraft.

Zwraca

Typ	Opis
str	Identyfikator potokuUruchom.

name

Tet nazwy pipelineDraft.

Zwraca

Typ	Opis
str	Nazwa.

parent_pipeline_draft_id

Pobierz identyfikator nadrzędnego elementu PipelineDraft potoku PotokDraft.

Zwraca

Typ	Opis
str	Identyfikator pipelineDraft.

parent_pipeline_id

Pobierz identyfikator nadrzędnego elementu PublishedPipeline potoku PipelineDraft.

Zwraca

Typ	Opis
str	Identyfikator OpublikowanePipeline.

parent_pipeline_run_id

Pobierz identyfikator nadrzędnego potokuUruchom pipelineDraft.

Zwraca

Typ	Opis
str	Identyfikator potokuUruchom.

parent_step_run_ids

Pobierz listę identyfikatorów KrokRun nadrzędnego potokuUruchom potoku potoku.

Zwraca

Typ	Opis
list	Lista identyfikatorów StepRun.

properties

Pobierz właściwości elementu PipelineDraft.

Zwraca

Typ	Opis
dict	Słownik właściwości.

Udostępnij za pośrednictwem

PipelineDraft Klasa

Konstruktor

Parametry

Uwagi

Metody

create

Parametry

Zwraca

delete

Parametry

get

Parametry

Zwraca

get_graph

Parametry

Zwraca

list

Parametry

Zwraca

publish

Parametry

Zwraca

save

Parametry

Zwraca

submit_run

Parametry

Zwraca

update

Parametry

Atrybuty

description

Zwraca

id

Zwraca

last_submitted_pipeline_run_id

Zwraca

name

Zwraca

parent_pipeline_draft_id

Zwraca

parent_pipeline_id

Zwraca

parent_pipeline_run_id

Zwraca

parent_step_run_ids

Zwraca

properties

Zwraca

tags

Zwraca

Opinia

Dodatkowe zasoby