PublishedPipeline Klasa

Odwołanie

Reprezentuje potok, który ma zostać przesłany bez kodu języka Python, który go skonstruował.

Ponadto funkcja PublishedPipeline może służyć do ponownego Pipeline wprowadzania wartości PipelineParameter i danych wejściowych.

Zainicjuj opublikowanąpipeline.

:p aram endpoint Adres URL punktu końcowego REST do przesyłania przebiegów potoku dla tego potoku. :type endpoint: str :p aram total_run_steps: liczba kroków w tym potoku :type total_run_steps: int :p aram workspace: obszar roboczy opublikowanego potoku. :type workspace: azureml.core.Workspace :p aram continue_on_step_failure: czy kontynuować wykonywanie innych kroków w potokuRun

jeśli krok zakończy się niepowodzeniem, wartość domyślna to false.

Dziedziczenie: azureml.core._portal.HasPipelinePortal

PublishedPipeline

Konstruktor

PublishedPipeline(name, graph_id, description, version, published_pipeline_id, status, endpoint, total_run_steps, workspace, continue_on_step_failure=None, _pipeline_provider=None, **kwargs)

Parametry

Nazwa	Opis
name Wymagane	str Nazwa opublikowanego potoku.
graph_id Wymagane	str Identyfikator grafu dla tego opublikowanego potoku.
description Wymagane	str Opis opublikowanego potoku.
version Wymagane	str Opublikowana wersja potoku.
published_pipeline_id Wymagane	str Identyfikator opublikowanego potoku.
status Wymagane	str Stan opublikowanego potoku ("Aktywny" lub "Wyłączony").
endpoint Wymagane	str Adres URL punktu końcowego REST do przesyłania przebiegów dla tego potoku.
total_run_steps Wymagane	int Liczba kroków w tym potoku.
workspace Wymagane	Workspace Obszar roboczy opublikowanego potoku.
continue_on_step_failure Wymagane	bool Czy kontynuować wykonywanie innych kroków w potokuUruchom, jeśli krok zakończy się niepowodzeniem. Wartością domyślną jest false.
_pipeline_provider Wymagane	<xref:azureml.pipeline.core._workflow_provider._PublishedPipelineProvider> Opublikowany dostawca potoku.
kwargs Wymagane	dict Niestandardowe argumenty słów kluczowych zarezerwowane do przyszłego programowania
name Wymagane	str Nazwa opublikowanego potoku.
graph_id Wymagane	str Identyfikator grafu dla tego opublikowanego potoku.
description Wymagane	str Opis opublikowanego potoku.
version Wymagane	str Opublikowana wersja potoku.
published_pipeline_id Wymagane	str Identyfikator opublikowanego potoku.
status Wymagane	str Stan opublikowanego potoku ("Aktywny" lub "Wyłączony").
_pipeline_provider Wymagane	<xref:azureml.pipeline.core._workflow_provider._PublishedPipelineProvider> Opublikowany dostawca potoku.
kwargs Wymagane	dict Niestandardowe argumenty słów kluczowych zarezerwowane do przyszłego programowania

Uwagi

Element PublishedPipeline można utworzyć na podstawie elementu Pipeline lub .PipelineRun

Przykład publikowania z potoku jest następujący:


   from azureml.pipeline.core import Pipeline

   pipeline = Pipeline(workspace=ws, steps=steps)
   published_pipeline = pipeline.publish(name="My_New_Pipeline",
                                         description="My New Pipeline Description",
                                         version="1.0",
                                         continue_on_step_failure=True)

Aby opublikować dane z elementu PipelineRun, użyj polecenia:


   from azureml.pipeline.core import PipelineRun

   pipeline_run = PipelineRun(experiment=Experiment(ws, "Pipeline_experiment"), run_id="run_id")
   published_pipeline = pipeline_run.publish_pipeline(name="My_New_Pipeline",
                                                      description="My New Pipeline Description",
                                                      version="1.0",
                                                      continue_on_step_failure=True)

Uwaga: parametr continue_on_step_failure określa, czy wykonanie kroków w potoku będzie kontynuowane, jeśli jeden krok zakończy się niepowodzeniem. Wartość domyślna to False, co oznacza, że gdy jeden krok zakończy się niepowodzeniem, wykonanie potoku zostanie zatrzymane, co spowoduje anulowanie wszystkich uruchomionych kroków.

Prześlij element PublishedPipeline przy użyciu polecenia submit. Po wywołaniu przesyłania tworzony jest element, PipelineRun który z kolei tworzy StepRun obiekty dla każdego kroku w przepływie pracy.

Przykład przesyłania elementu PublishedPipeline jest następujący:


   from azureml.pipeline.core import PublishedPipeline

   published_pipeline = PublishedPipeline.get(workspace=ws, id="published_pipeline_id")
   pipeline_run = experiment.submit(published_pipeline)

Istnieje wiele opcjonalnych ustawień, które można określić podczas przesyłania elementu PublishedPipeline. Są one następujące:

continue_on_step_failure: czy kontynuować wykonywanie innych kroków w potokuRun, jeśli krok zakończy się niepowodzeniem, opcjonalnie. Tylko kroki, które nie mają zależności od danych wyjściowych kroku, którego wykonanie zakończyło się niepowodzeniem, będzie kontynuowane. Jeśli zostanie podane, to ustawienie parametru zastępuje ustawienie w potoku.
pipeline_parameters: Parametry wykonywania potoku, słownik {name: value}. Aby uzyskać więcej informacji, zobacz PipelineParameter .
parent_run_id: możesz podać identyfikator uruchomienia, aby ustawić nadrzędny przebieg tego uruchomienia potoku, który jest odzwierciedlony w runHistory. Uruchomienie nadrzędne musi należeć do tego samego eksperymentu co przesłany potok.

Przykład przesyłania opublikowanegopipeline przy użyciu tych ustawień jest następujący:


   from azureml.pipeline.core import PublishedPipeline

   published_pipeline = PublishedPipeline.get(workspace=ws, id="published_pipeline_id")
   pipeline_run = experiment.submit(published_pipeline,
                                    continue_on_step_failure=True,
                                    pipeline_parameters={"param1": "value1"},
                                    parent_run_id="<run_id>")

Wszystkie opublikowane potoki mają punkt końcowy REST. Za pomocą punktu końcowego potoku można wyzwolić uruchomienie potoku z systemów zewnętrznych, takich jak klienci spoza języka Python. Aby uzyskać informacje o sposobie uwierzytelniania podczas wywoływania punktów końcowych REST, zobacz https://aka.ms/pl-restep-auth.

Użycie punktu końcowego umożliwia na przykład "powtarzalność zarządzaną" w scenariuszach oceniania wsadowego i ponownego trenowania. Aby uzyskać więcej informacji, zobacz https://aka.ms/pl-first-pipeline.

Metody

disable	Ustaw opublikowany potok na wartość "Disabled" (Wyłączone) i niedostępny do uruchomienia.
enable	Ustaw opublikowany potok na "Aktywny" i dostępny do uruchomienia.
get	Pobierz opublikowany potok.
get_all	Pobierz wszystkie opublikowane potoki w bieżącym obszarze roboczym. PRZESTARZAŁE: Ta metoda jest przestarzała na rzecz metody PublishedPipeline list .
get_graph	Pobierz wykres elementu PublishedPipeline.
get_step_names	Pobierz listę nazw kroków w polu PublishedPipeline.
list	Pobierz wszystkie opublikowane potoki w bieżącym obszarze roboczym.
save	Zapisz plik YAML potoku. Obecnie tylko potoki składające się z modułówKrok są obsługiwane w przypadku eksportowania kodu YAML.
submit	Prześlij opublikowany potok. Jest to równoważne użyciu polecenia submit. Zwraca przesłany PipelineRunelement . Ten obiekt służy do monitorowania i wyświetlania szczegółów przebiegu.

disable

Ustaw opublikowany potok na wartość "Disabled" (Wyłączone) i niedostępny do uruchomienia.

disable()

enable

Ustaw opublikowany potok na "Aktywny" i dostępny do uruchomienia.

enable()

get

Pobierz opublikowany potok.

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

Parametry

Nazwa	Opis
workspace Wymagane	Workspace Obszar roboczy, w ramach którego został utworzony opublikowany potok.
id Wymagane	str Identyfikator opublikowanego potoku.
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Dostawca przepływu pracy. Domyślna wartość: None
_service_endpoint	str Punkt końcowy usługi. Domyślna wartość: None

Zwraca

Typ	Opis
PublishedPipeline	Obiekt PublishedPipeline.

get_all

Pobierz wszystkie opublikowane potoki w bieżącym obszarze roboczym.

PRZESTARZAŁE: Ta metoda jest przestarzała na rzecz metody PublishedPipeline list .

static get_all(workspace, active_only=True, _service_endpoint=None)

Parametry

Nazwa	Opis
workspace Wymagane	Workspace Obszar roboczy, w ramach którego został utworzony opublikowany potok.
active_only	bool Czy zwracać tylko opublikowane potoki, które są obecnie aktywne. Domyślna wartość: True
_service_endpoint	str Punkt końcowy usługi. Domyślna wartość: None

Zwraca

Typ	Opis
list[PublishedPipeline]	Lista obiektów PublishedPipeline.

get_graph

Pobierz wykres elementu PublishedPipeline.

get_graph(_workflow_provider=None)

Parametry

Nazwa	Opis
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Dostawca przepływu pracy. Domyślna wartość: None

Zwraca

Typ	Opis
Graph	Wykres.

get_step_names

Pobierz listę nazw kroków w polu PublishedPipeline.

get_step_names(_workflow_provider=None)

Parametry

Nazwa	Opis
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Dostawca przepływu pracy. Domyślna wartość: None

Zwraca

Typ	Opis
List[str]	Lista nazw kroków w polu PublishedPipeline.

list

Pobierz wszystkie opublikowane potoki w bieżącym obszarze roboczym.

static list(workspace, active_only=True, _service_endpoint=None)

Parametry

Nazwa	Opis
workspace Wymagane	Workspace Obszar roboczy, w ramach którego został utworzony opublikowany potok.
active_only	bool Czy zwracać tylko opublikowane potoki, które są obecnie aktywne. Domyślna wartość: True
_service_endpoint	str Punkt końcowy usługi. Domyślna wartość: None

Zwraca

Typ	Opis
list[PublishedPipeline]	Lista obiektów PublishedPipeline.

save

Zapisz plik YAML potoku.

Obecnie tylko potoki składające się z modułówKrok są obsługiwane w przypadku eksportowania kodu YAML.

save(path=None, _workflow_provider=None)

Parametry

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

Zwraca

Typ	Opis
None

submit

Prześlij opublikowany potok. Jest to równoważne użyciu polecenia submit.

Zwraca przesłany PipelineRunelement . Ten obiekt służy do monitorowania i wyświetlania szczegółów przebiegu.

submit(workspace, experiment_name, pipeline_parameters=None, _workflow_provider=None, _service_endpoint=None, parent_run_id=None, continue_on_step_failure=None)

Parametry

Nazwa	Opis
workspace Wymagane	Workspace Obszar roboczy do przesyłania opublikowanego potoku.
experiment_name Wymagane	str Nazwa eksperymentu do przesłania.
pipeline_parameters	dict Słownik parametrów do przypisywania nowych wartości {param name, param value}. Zobacz PipelineParameter , aby uzyskać więcej informacji. Domyślna wartość: None
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Dostawca przepływu pracy. Domyślna wartość: None
_service_endpoint	str Punkt końcowy usługi. Domyślna wartość: None
parent_run_id	str Opcjonalny identyfikator przebiegu do ustawienia dla nadrzędnego przebiegu tego uruchomienia potoku, który jest odzwierciedlony w runHistory. Uruchomienie nadrzędne musi należeć do tego samego eksperymentu, do którego jest przesyłany ten potok. Domyślna wartość: None
continue_on_step_failure	bool Czy kontynuować wykonywanie innych kroków w potokuRun, jeśli krok zakończy się niepowodzeniem, opcjonalnie. Jeśli zostanie podana, zastąpi ustawienie potoku. Domyślna wartość: None

Zwraca

Typ	Opis
PipelineRun	Przesłane uruchomienie potoku.

Atrybuty

continue_on_step_failure

Pobierz wartość continue_on_step_failure ustawienia.

Zwraca

Typ	Opis
bool	Wartość `continue_on_step_failure` ustawienia.

description

Pobierz opis opublikowanego potoku.

Zwraca

Typ	Opis
str	Opis opublikowanego potoku.

endpoint

Pobierz adres URL punktu końcowego REST na potrzeby uruchamiania opublikowanego potoku.

Zwraca

Typ	Opis
str	Adres URL punktu końcowego REST do uruchamiania opublikowanego potoku.

graph_id

Pobierz identyfikator grafu dla tego opublikowanego potoku.

Zwraca

Typ	Opis
str	Identyfikator grafu.

id

Pobierz identyfikator opublikowanego potoku.

Zwraca

Typ	Opis
str	Identyfikator opublikowanego potoku.

name

Pobierz nazwę opublikowanego potoku.

Zwraca

Typ	Opis
str	Nazwa opublikowanego potoku.

status

Pobierz stan opublikowanego potoku.

Zwraca

Typ	Opis
str	Stan opublikowanego potoku.

total_run_steps

Uzyskaj liczbę kroków w potoku.

Zwraca

Typ	Opis
int	Liczba kroków w potoku.

version

Pobierz wersję opublikowanego potoku.

Zwraca

Typ	Opis
str	Wersja opublikowanego potoku.

Udostępnij za pośrednictwem

PublishedPipeline Klasa

Konstruktor

Parametry

Uwagi

Metody

disable

enable

get

Parametry

Zwraca

get_all

Parametry

Zwraca

get_graph

Parametry

Zwraca

get_step_names

Parametry

Zwraca

list

Parametry

Zwraca

save

Parametry

Zwraca

submit

Parametry

Zwraca

Atrybuty

continue_on_step_failure

Zwraca

description

Zwraca

endpoint

Zwraca

graph_id

Zwraca

id

Zwraca

name

Zwraca

status

Zwraca

total_run_steps

Zwraca

version

Zwraca

Opinia

Dodatkowe zasoby