PublishedPipeline Klasa
Reprezentuje potok do przesłania bez kodu w języku Python, który go skonstruował.
Ponadto funkcja PublishedPipeline może służyć do ponownego przesłanie elementu Pipeline z różnymi PipelineParameter wartościami i danymi wejściowymi.
Zainicjuj wartość PublishedPipeline.
:p aram punkt końcowy ADRESU 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 potokuUruchom
Jeśli krok zakończy się niepowodzeniem, wartość domyślna to false.
- Dziedziczenie
-
azureml.core._portal.HasPipelinePortalPublishedPipeline
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
|
Nazwa opublikowanego potoku. |
graph_id
Wymagane
|
Identyfikator grafu dla tego opublikowanego potoku. |
description
Wymagane
|
Opis opublikowanego potoku. |
version
Wymagane
|
Opublikowana wersja potoku. |
published_pipeline_id
Wymagane
|
Identyfikator opublikowanego potoku. |
status
Wymagane
|
Stan opublikowanego potoku ("Aktywny" lub "Wyłączony"). |
endpoint
Wymagane
|
Adres URL punktu końcowego REST do przesyłania przebiegów dla tego potoku. |
total_run_steps
Wymagane
|
Liczba kroków w tym potoku. |
workspace
Wymagane
|
Obszar roboczy opublikowanego potoku. |
continue_on_step_failure
Wymagane
|
Czy kontynuować wykonywanie innych kroków w potokuRun, 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
|
Niestandardowe argumenty słów kluczowych zarezerwowane do przyszłego programowania |
name
Wymagane
|
Nazwa opublikowanego potoku. |
graph_id
Wymagane
|
Identyfikator grafu dla tego opublikowanego potoku. |
description
Wymagane
|
Opis opublikowanego potoku. |
version
Wymagane
|
Opublikowana wersja potoku. |
published_pipeline_id
Wymagane
|
Identyfikator opublikowanego potoku. |
status
Wymagane
|
Stan opublikowanego potoku ("Aktywny" lub "Wyłączone"). |
_pipeline_provider
Wymagane
|
<xref:azureml.pipeline.core._workflow_provider._PublishedPipelineProvider>
Opublikowany dostawca potoku. |
kwargs
Wymagane
|
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ć 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 w przypadku niepowodzenia jednego kroku. Wartość domyślna to False, co oznacza, że w przypadku niepowodzenia jednego kroku 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 obiekt, 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 potokuUruchom, jeśli krok zakończy się niepowodzeniem, opcjonalnie. Tylko kroki, które nie mają zależności od danych wyjściowych kroku, który zakończył się niepowodzeniem, będą kontynuowane. Jeśli to ustawienie parametru zostanie podane, zastąpi to ustawienie w potoku.
pipeline_parameters: Parametry wykonywania potoku, słownik {name: value}. Zobacz PipelineParameter , aby uzyskać więcej informacji.
parent_run_id: możesz podać identyfikator uruchomienia, aby ustawić nadrzędne uruchomienie tego uruchomienia potoku, które znajduje odzwierciedlenie w runHistory. Przebieg nadrzędny musi należeć do tego samego eksperymentu, co przesyłany potok.
Przykład przesyłania elementu PublishedPipeline 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 "zarządzaną powtarzalność" 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 "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 graf opublikowanegopipeline. |
get_step_names |
Pobierz listę nazw kroków w opublikowanejpipeline. |
list |
Pobierz wszystkie opublikowane potoki w bieżącym obszarze roboczym. |
save |
Zapisz plik YAML potoku. Obecnie tylko potoki składające się z modułówSteps są obsługiwane w przypadku eksportowania YAML. |
submit |
Prześlij opublikowany potok. Jest to równoważne użyciu elementu submit. Zwraca przesłany element PipelineRun. Ten obiekt służy do monitorowania i wyświetlania szczegółów przebiegu. |
disable
Ustaw opublikowany potok na "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
|
Obszar roboczy, w ramach którego został utworzony opublikowany potok. |
id
Wymagane
|
Identyfikator opublikowanego potoku. |
_workflow_provider
|
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
Dostawca przepływu pracy. Domyślna wartość: None
|
_service_endpoint
|
Punkt końcowy usługi. Domyślna wartość: None
|
Zwraca
Typ | Opis |
---|---|
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
|
Obszar roboczy, w ramach którego został utworzony opublikowany potok. |
active_only
|
Czy zwracać tylko opublikowane potoki, które są obecnie aktywne. Domyślna wartość: True
|
_service_endpoint
|
Punkt końcowy usługi. Domyślna wartość: None
|
Zwraca
Typ | Opis |
---|---|
Lista obiektów PublishedPipeline. |
get_graph
Pobierz graf opublikowanegopipeline.
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 |
---|---|
Wykres. |
get_step_names
Pobierz listę nazw kroków w opublikowanejpipeline.
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 |
---|---|
Lista nazw kroków w opublikowanympipeline. |
list
Pobierz wszystkie opublikowane potoki w bieżącym obszarze roboczym.
static list(workspace, active_only=True, _service_endpoint=None)
Parametry
Nazwa | Opis |
---|---|
workspace
Wymagane
|
Obszar roboczy, w ramach którego został utworzony opublikowany potok. |
active_only
|
Czy zwracać tylko opublikowane potoki, które są obecnie aktywne. Domyślna wartość: True
|
_service_endpoint
|
Punkt końcowy usługi. Domyślna wartość: None
|
Zwraca
Typ | Opis |
---|---|
Lista obiektów PublishedPipeline. |
save
Zapisz plik YAML potoku.
Obecnie tylko potoki składające się z modułówSteps są obsługiwane w przypadku eksportowania YAML.
save(path=None, _workflow_provider=None)
Parametry
Nazwa | Opis |
---|---|
path
|
Ś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 Brak, 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 |
---|---|
submit
Prześlij opublikowany potok. Jest to równoważne użyciu elementu submit.
Zwraca przesłany element PipelineRun. 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
|
Obszar roboczy do przesłania opublikowanego potoku. |
experiment_name
Wymagane
|
Nazwa eksperymentu do przesłania. |
pipeline_parameters
|
Słownik parametrów do przypisywania nowych wartości {param name, param value}. Aby uzyskać więcej informacji, zobacz PipelineParameter . Domyślna wartość: None
|
_workflow_provider
|
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
Dostawca przepływu pracy. Domyślna wartość: None
|
_service_endpoint
|
Punkt końcowy usługi. Domyślna wartość: None
|
parent_run_id
|
Opcjonalny identyfikator uruchomienia ustawiony dla nadrzędnego uruchomienia 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
|
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 |
---|---|
Przesłane uruchomienie potoku. |
Atrybuty
continue_on_step_failure
Pobierz wartość continue_on_step_failure
ustawienia.
Zwraca
Typ | Opis |
---|---|
Wartość |
description
endpoint
Pobierz adres URL punktu końcowego REST na potrzeby uruchamiania opublikowanego potoku.
Zwraca
Typ | Opis |
---|---|
Adres URL punktu końcowego REST do uruchamiania opublikowanego potoku. |
graph_id
Pobierz identyfikator grafu dla tego opublikowanego potoku.
Zwraca
Typ | Opis |
---|---|
Identyfikator grafu. |