PipelineRun Klasa

  • Odwołanie

Reprezentuje przebieg elementu Pipeline.

Ta klasa może służyć do zarządzania, sprawdzania stanu i pobierania szczegółów przebiegu po przesłaniu przebiegu potoku. Służy get_steps do pobierania StepRun obiektów utworzonych przez przebieg potoku. Inne zastosowania obejmują pobieranie Graph obiektu skojarzonego z uruchomieniem potoku, pobieranie stanu uruchomienia potoku i oczekiwanie na ukończenie przebiegu.

Inicjowanie uruchomienia potoku.

Dziedziczenie
Run
PipelineRun

Konstruktor

PipelineRun(experiment, run_id, _service_endpoint=None, **kwags)

Parametry

Nazwa Opis
experiment
Wymagane
Experiment

Obiekt eksperymentu skojarzony z uruchomieniem potoku.
run_id
Wymagane
str

Identyfikator przebiegu potoku.
_service_endpoint
str

Punkt końcowy do nawiązania połączenia.

wartość domyślna: None
experiment
Wymagane
Experiment

Obiekt eksperymentu skojarzony z uruchomieniem potoku.
run_id
Wymagane
str

Identyfikator przebiegu potoku.
_service_endpoint
Wymagane
str

Punkt końcowy do nawiązania połączenia.

Uwagi

Obiekt PipelineRun jest zwracany podczas przesyłania elementu Pipeline za pośrednictwem submitelementu . metoda .Experiment Aby uzyskać więcej informacji na temat tworzenia i przesyłania potoku, zobacz: https://aka.ms/pl-first-pipeline.

Można również utworzyć wystąpienie potoku Experiment za pomocą przebiegu, do którego został przesłany identyfikator PipelineRun w następujący sposób:


   from azureml.core import Experiment
   from azureml.pipeline.core import PipelineRun

   experiment = Experiment(workspace, "<experiment_name>")
   pipeline_run = PipelineRun(experiment, "<pipeline_run_id>")

Podczas pracy z funkcją PipelineRun użyj:

  • wait_for_completion aby monitorować stan przebiegu i opcjonalnie przesyłać strumieniowo dzienniki uruchamiania.

  • get_status aby pobrać stan przebiegu.

  • cancel aby anulować bieżący przebieg potoku.

  • get_steps aby wyświetlić listę wygenerowanych krokrunów. Element PipelineRun generuje element StepRun dla każdego kroku w potoku.

Metody

cancel

Anuluj bieżący przebieg.
child_run

Utwórz podrzędne uruchomienie dla przebiegu potoku. Ta metoda nie jest zaimplementowana dla metody PipelineRun.
complete

Oznacz przebieg potoku jako ukończony. Ta metoda nie jest zaimplementowana dla metody PipelineRun.

Ta metoda nie jest obsługiwana w przypadku potoków; stan ukończenia/niepowodzenia jest zarządzany przez zaplecze usługi Azure ML.
fail

Oznacz przebieg potoku jako niepowodzenie. Ta metoda nie jest zaimplementowana dla metody PipelineRun.

Ta metoda nie jest obsługiwana w przypadku potoków; stan ukończenia/niepowodzenia jest zarządzany przez zaplecze usługi Azure ML.
find_step_run

Znajdź przebieg kroku w potoku według nazwy.
get

Pobierz przebieg potoku na podstawie identyfikatora przebiegu.
get_graph

Pobierz wykres przebiegu potoku.
get_pipeline_output

Pobierz wartość PortDataReference dla danych wyjściowych danego potoku.
get_pipeline_runs

Pobierz uruchomienia potoku wygenerowane na podstawie opublikowanego potoku.
get_status

Pobierz najnowszy stan przebiegu potoku z usługi.

Zwracane wspólne wartości to "Running", "Finished" i "Failed".
get_steps

Pobierz przebiegi kroku dla wszystkich kroków potoku, które zostały ukończone lub uruchomione.
get_tags

Pobierz zestaw tagów dla przebiegu.
publish_pipeline

Publikowanie potoku i udostępnianie go do ponownego uruchamiania.

Punkt końcowy potoku można pobrać z obiektu PublishedPipeline zwróconego przez tę funkcję. Za pomocą punktu końcowego potoku można wywołać potok z aplikacji zewnętrznych przy użyciu wywołań REST. Aby uzyskać informacje o sposobie uwierzytelniania podczas wywoływania punktów końcowych REST, zobacz https://aka.ms/pl-restep-auth.

Oryginalny potok skojarzony z uruchomieniem potoku jest używany jako podstawa opublikowanego potoku.
save

Zapisz potok YAML w pliku.
wait_for_completion

Poczekaj na ukończenie tego uruchomienia potoku.

Zwraca stan po oczekiwaniu.

cancel

Anuluj bieżący przebieg.

cancel()

child_run

Utwórz podrzędne uruchomienie dla przebiegu potoku. Ta metoda nie jest zaimplementowana dla metody PipelineRun.

child_run(name=None, run_id=None, outputs=None)

Parametry

Nazwa Opis
name
str

Opcjonalna nazwa elementu podrzędnego.

wartość domyślna: None
run_id
str

Opcjonalny identyfikator uruchomienia dla elementu podrzędnego, w przeciwnym razie używa wartości domyślnej.

wartość domyślna: None
outputs
str

Opcjonalny katalog wyjściowy do śledzenia dla elementu podrzędnego.

wartość domyślna: None

Zwraca

Typ Opis
Run

Uruchom element podrzędny.

Wyjątki

Typ Opis
NotImplementedError

complete

Oznacz przebieg potoku jako ukończony. Ta metoda nie jest zaimplementowana dla metody PipelineRun.

Ta metoda nie jest obsługiwana w przypadku potoków; stan ukończenia/niepowodzenia jest zarządzany przez zaplecze usługi Azure ML.

complete()

Wyjątki

Typ Opis
NotImplementedError

fail

Oznacz przebieg potoku jako niepowodzenie. Ta metoda nie jest zaimplementowana dla metody PipelineRun.

Ta metoda nie jest obsługiwana w przypadku potoków; stan ukończenia/niepowodzenia jest zarządzany przez zaplecze usługi Azure ML.

fail()

Wyjątki

Typ Opis
NotImplementedError

find_step_run

Znajdź przebieg kroku w potoku według nazwy.

find_step_run(name)

Parametry

Nazwa Opis
name
Wymagane
str

Nazwa kroku do znalezienia.

Zwraca

Typ Opis
list

StepRun Lista obiektów o podanej nazwie.

get

Pobierz przebieg potoku na podstawie identyfikatora przebiegu.

static get(workspace, run_id, _service_endpoint=None)

Parametry

Nazwa Opis
workspace
Wymagane
Workspace

Obszar roboczy skojarzony z potokiem.
run_id
Wymagane
str

Identyfikator przebiegu potoku.
_service_endpoint
str

Punkt końcowy do nawiązania połączenia.

wartość domyślna: None

Zwraca

Typ Opis
PipelineRun

Obiekt PipelineRun.

get_graph

Pobierz wykres przebiegu potoku.

get_graph()

Zwraca

Typ Opis
Graph

Wykres.

get_pipeline_output

Pobierz wartość PortDataReference dla danych wyjściowych danego potoku.

get_pipeline_output(pipeline_output_name)

Parametry

Nazwa Opis
pipeline_output_name
Wymagane
str

Nazwa danych wyjściowych potoku do pobrania.

Zwraca

Typ Opis
PortDataReference

PortDataReference reprezentujący dane wyjściowe potoku.

get_pipeline_runs

Pobierz uruchomienia potoku wygenerowane na podstawie opublikowanego potoku.

static get_pipeline_runs(workspace, pipeline_id, _service_endpoint=None)

Parametry

Nazwa Opis
workspace
Wymagane
Workspace

Obszar roboczy skojarzony z potokiem.
pipeline_id
Wymagane
str

Identyfikator opublikowanego potoku.
_service_endpoint
str

Punkt końcowy do nawiązania połączenia.

wartość domyślna: None

Zwraca

Typ Opis
list

Lista PipelineRun obiektów.

get_status

Pobierz najnowszy stan przebiegu potoku z usługi.

Zwracane wspólne wartości to "Running", "Finished" i "Failed".

get_status()

Zwraca

Typ Opis
str

Najnowszy stan jako ciąg.

Uwagi

  • NotStarted — jest to tymczasowy stan obiektów uruchomień po stronie klienta przed przesłaniem chmury

  • Uruchomiono — zadanie zostało uruchomione w docelowym obiekcie obliczeniowym.

  • Niepowodzenie — przebieg zakończył się niepowodzeniem. Zazwyczaj właściwość Error w przebiegu zawiera szczegółowe informacje o przyczynie.

  • Zakończono — przebieg został ukończony pomyślnie.

  • Anulowano — po żądaniu anulowania przebieg został pomyślnie anulowany.


   run = experiment.submit(config)
   while run.get_status() not in ['Finished', 'Failed']: # For example purposes only, not exhaustive
       print('Run {} not in terminal state'.format(run.id))
       time.sleep(10)

get_steps

Pobierz przebiegi kroku dla wszystkich kroków potoku, które zostały ukończone lub uruchomione.

get_steps()

Zwraca

Typ Opis
list

Lista StepRun obiektów.

get_tags

Pobierz zestaw tagów dla przebiegu.

get_tags()

Zwraca

Typ Opis
dict

Słownik tagów dla przebiegu.

publish_pipeline

Publikowanie potoku i udostępnianie go do ponownego uruchamiania.

Punkt końcowy potoku można pobrać z obiektu PublishedPipeline zwróconego przez tę funkcję. Za pomocą punktu końcowego potoku można wywołać potok z aplikacji zewnętrznych przy użyciu wywołań REST. Aby uzyskać informacje o sposobie uwierzytelniania podczas wywoływania punktów końcowych REST, zobacz https://aka.ms/pl-restep-auth.

Oryginalny potok skojarzony z uruchomieniem potoku jest używany jako podstawa opublikowanego potoku.

publish_pipeline(name, description, version, continue_on_step_failure=None, **kwargs)

Parametry

Nazwa Opis
name
Wymagane
str

Nazwa opublikowanego potoku.
description
Wymagane
str

Opis opublikowanego potoku.
version
Wymagane
str

Wersja opublikowanego potoku.
continue_on_step_failure
bool

Czy kontynuować wykonywanie innych kroków w potokuRun, jeśli krok zakończy się niepowodzeniem. Wartość domyślna to False.

wartość domyślna: None
kwargs
Wymagane
dict

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

Zwraca

Typ Opis
PublishedPipeline

Utworzono opublikowany potok.

save

Zapisz potok YAML w pliku.

save(path=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.yml. Jeśli ścieżka nie jest żadna, używany jest bieżący katalog.

wartość domyślna: None

Zwraca

Typ Opis
None

wait_for_completion

Poczekaj na ukończenie tego uruchomienia potoku.

Zwraca stan po oczekiwaniu.

wait_for_completion(show_output=True, timeout_seconds=9223372036854775807, raise_on_error=True)

Parametry

Nazwa Opis
show_output
bool

Wskazuje, czy stan uruchomienia potoku ma być wyświetlany w pliku sys.stdout.

wartość domyślna: True
timeout_seconds
int

Liczba sekund oczekiwania przed upływem limitu czasu.

wartość domyślna: 9223372036854775807
raise_on_error
bool

Wskazuje, czy należy zgłosić błąd, gdy przebieg jest w stanie niepowodzenia.

wartość domyślna: True

Zwraca

Typ Opis
str

Stan końcowy.