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

name
str
Wymagane

Nazwa opublikowanego potoku.

graph_id
str
Wymagane

Identyfikator grafu dla tego opublikowanego potoku.

description
str
Wymagane

Opis opublikowanego potoku.

version
str
Wymagane

Opublikowana wersja potoku.

published_pipeline_id
str
Wymagane

Identyfikator opublikowanego potoku.

status
str
Wymagane

Stan opublikowanego potoku ("Aktywny" lub "Wyłączony").

endpoint
str
Wymagane

Adres URL punktu końcowego REST do przesyłania przebiegów dla tego potoku.

total_run_steps
int
Wymagane

Liczba kroków w tym potoku.

workspace
Workspace
Wymagane

Obszar roboczy opublikowanego potoku.

continue_on_step_failure
bool
Wymagane

Czy kontynuować wykonywanie innych kroków w potokuUruchom, jeśli krok zakończy się niepowodzeniem. Wartością domyślną jest false.

_pipeline_provider
<xref:azureml.pipeline.core._workflow_provider._PublishedPipelineProvider>
Wymagane

Opublikowany dostawca potoku.

kwargs
dict
Wymagane

Niestandardowe argumenty słów kluczowych zarezerwowane do przyszłego programowania

name
str
Wymagane

Nazwa opublikowanego potoku.

graph_id
str
Wymagane

Identyfikator grafu dla tego opublikowanego potoku.

description
str
Wymagane

Opis opublikowanego potoku.

version
str
Wymagane

Opublikowana wersja potoku.

published_pipeline_id
str
Wymagane

Identyfikator opublikowanego potoku.

status
str
Wymagane

Stan opublikowanego potoku ("Aktywny" lub "Wyłączony").

_pipeline_provider
<xref:azureml.pipeline.core._workflow_provider._PublishedPipelineProvider>
Wymagane

Opublikowany dostawca potoku.

kwargs
dict
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ć 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

workspace
Workspace
Wymagane

Obszar roboczy, w ramach którego został utworzony opublikowany potok.

id
str
Wymagane

Identyfikator opublikowanego potoku.

_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
wartość domyślna: None

Dostawca przepływu pracy.

_service_endpoint
str
wartość domyślna: None

Punkt końcowy usługi.

Zwraca

Obiekt PublishedPipeline.

Typ zwracany

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

workspace
Workspace
Wymagane

Obszar roboczy, w ramach którego został utworzony opublikowany potok.

active_only
bool
wartość domyślna: True

Czy zwracać tylko opublikowane potoki, które są obecnie aktywne.

_service_endpoint
str
wartość domyślna: None

Punkt końcowy usługi.

Zwraca

Lista obiektów PublishedPipeline.

Typ zwracany

list[PublishedPipeline]

get_graph

Pobierz wykres elementu PublishedPipeline.

get_graph(_workflow_provider=None)

Parametry

_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
wartość domyślna: None

Dostawca przepływu pracy.

Zwraca

Wykres.

Typ zwracany

Graph

get_step_names

Pobierz listę nazw kroków w polu PublishedPipeline.

get_step_names(_workflow_provider=None)

Parametry

_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
wartość domyślna: None

Dostawca przepływu pracy.

Zwraca

Lista nazw kroków w polu PublishedPipeline.

Typ zwracany

List[str]

list

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

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

Parametry

workspace
Workspace
Wymagane

Obszar roboczy, w ramach którego został utworzony opublikowany potok.

active_only
bool
wartość domyślna: True

Czy zwracać tylko opublikowane potoki, które są obecnie aktywne.

_service_endpoint
str
wartość domyślna: None

Punkt końcowy usługi.

Zwraca

Lista obiektów PublishedPipeline.

Typ zwracany

list[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

path
str
wartość domyślna: None

Ś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.

_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
wartość domyślna: None

Dostawca przepływu pracy.

Typ zwracany

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

workspace
Workspace
Wymagane

Obszar roboczy do przesyłania opublikowanego potoku.

experiment_name
str
Wymagane

Nazwa eksperymentu do przesłania.

pipeline_parameters
dict
wartość domyślna: None

Słownik parametrów do przypisywania nowych wartości {param name, param value}. Zobacz PipelineParameter , aby uzyskać więcej informacji.

_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
wartość domyślna: None

Dostawca przepływu pracy.

_service_endpoint
str
wartość domyślna: None

Punkt końcowy usługi.

parent_run_id
str
wartość domyślna: None

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.

continue_on_step_failure
bool
wartość domyślna: None

Czy kontynuować wykonywanie innych kroków w potokuRun, jeśli krok zakończy się niepowodzeniem, opcjonalnie. Jeśli zostanie podana, zastąpi ustawienie potoku.

Zwraca

Przesłane uruchomienie potoku.

Typ zwracany

PipelineRun

Atrybuty

continue_on_step_failure

Pobierz wartość continue_on_step_failure ustawienia.

Zwraca

Wartość continue_on_step_failure ustawienia.

Typ zwracany

bool

description

Pobierz opis opublikowanego potoku.

Zwraca

Opis opublikowanego potoku.

Typ zwracany

str

endpoint

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

Zwraca

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

Typ zwracany

str

graph_id

Pobierz identyfikator grafu dla tego opublikowanego potoku.

Zwraca

Identyfikator grafu.

Typ zwracany

str

id

Pobierz identyfikator opublikowanego potoku.

Zwraca

Identyfikator opublikowanego potoku.

Typ zwracany

str

name

Pobierz nazwę opublikowanego potoku.

Zwraca

Nazwa opublikowanego potoku.

Typ zwracany

str

status

Pobierz stan opublikowanego potoku.

Zwraca

Stan opublikowanego potoku.

Typ zwracany

str

total_run_steps

Uzyskaj liczbę kroków w potoku.

Zwraca

Liczba kroków w potoku.

Typ zwracany

int

version

Pobierz wersję opublikowanego potoku.

Zwraca

Wersja opublikowanego potoku.

Typ zwracany

str