PipelineRun Klasa

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

experiment

Experiment

Wymagane

Obiekt eksperymentu skojarzony z uruchomieniem potoku.

run_id

str

Wymagane

Identyfikator przebiegu potoku.

_service_endpoint

str

wartość domyślna: None

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

experiment

Experiment

Wymagane

Obiekt eksperymentu skojarzony z uruchomieniem potoku.

run_id

str

Wymagane

Identyfikator przebiegu potoku.

_service_endpoint

str

Wymagane

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

name

str

wartość domyślna: None

Opcjonalna nazwa elementu podrzędnego.

run_id

str

wartość domyślna: None

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

outputs

str

wartość domyślna: None

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

Zwraca

Uruchom element podrzędny.

Typ zwracany

Run

Wyjątki

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

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

NotImplementedError

find_step_run

Znajdź przebieg kroku w potoku według nazwy.

find_step_run(name)

Parametry

name

str

Wymagane

Nazwa kroku do znalezienia.

Zwraca

StepRun Lista obiektów o podanej nazwie.

Typ zwracany

list

get

Pobierz przebieg potoku na podstawie identyfikatora przebiegu.

static get(workspace, run_id, _service_endpoint=None)

Parametry

workspace

Workspace

Wymagane

Obszar roboczy skojarzony z potokiem.

run_id

str

Wymagane

Identyfikator przebiegu potoku.

_service_endpoint

str

wartość domyślna: None

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

Zwraca

Obiekt PipelineRun.

Typ zwracany

PipelineRun

get_graph

Pobierz wykres przebiegu potoku.

get_graph()

Zwraca

Wykres.

Typ zwracany

Graph

get_pipeline_output

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

get_pipeline_output(pipeline_output_name)

Parametry

pipeline_output_name

str

Wymagane

Nazwa danych wyjściowych potoku do pobrania.

Zwraca

PortDataReference reprezentujący dane wyjściowe potoku.

Typ zwracany

PortDataReference

get_pipeline_runs

Pobierz uruchomienia potoku wygenerowane na podstawie opublikowanego potoku.

static get_pipeline_runs(workspace, pipeline_id, _service_endpoint=None)

Parametry

workspace

Workspace

Wymagane

Obszar roboczy skojarzony z potokiem.

pipeline_id

str

Wymagane

Identyfikator opublikowanego potoku.

_service_endpoint

str

wartość domyślna: None

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

Zwraca

Lista PipelineRun obiektów.

Typ zwracany

list

get_status

Pobierz najnowszy stan przebiegu potoku z usługi.

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

get_status()

Zwraca

Najnowszy stan jako ciąg.

Typ zwracany

str

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

Lista StepRun obiektów.

Typ zwracany

list

get_tags

Pobierz zestaw tagów dla przebiegu.

get_tags()

Zwraca

Słownik tagów dla przebiegu.

Typ zwracany

dict

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

name

str

Wymagane

Nazwa opublikowanego potoku.

description

str

Wymagane

Opis opublikowanego potoku.

version

str

Wymagane

Wersja opublikowanego potoku.

continue_on_step_failure

bool

wartość domyślna: None

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

kwargs

dict

Wymagane

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

Zwraca

Utworzono opublikowany potok.

Typ zwracany

PublishedPipeline

save

Zapisz potok YAML w pliku.

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

Typ zwracany

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

show_output

bool

wartość domyślna: True

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

timeout_seconds

int

wartość domyślna: 9223372036854775807

Liczba sekund oczekiwania przed upływem limitu czasu.

raise_on_error

bool

wartość domyślna: True

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

Zwraca

Stan końcowy.

Typ zwracany

str