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
-
PipelineRun
Konstruktor
PipelineRun(experiment, run_id, _service_endpoint=None, **kwags)
Parametry
Uwagi
Obiekt PipelineRun jest zwracany podczas przesyłania Pipeline elementu za pośrednictwem elementu submit. metoda klasy Experiment. Aby uzyskać więcej informacji na temat tworzenia i przesyłania potoku, zobacz: https://aka.ms/pl-first-pipeline.
Element PipelineRun można również utworzyć wystąpienie z przebiegiem Experiment przesłanym do elementu i identyfikatorem 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ć trwający potokUruchom.
get_steps aby wyświetlić listę wygenerowanych krokrunów. Element PipelineRun generuje element StepRun dla każdego kroku w potoku.
Metody
cancel |
Anuluj trwający przebieg. |
child_run |
Utwórz podrzędne uruchomienie dla uruchomienia potoku. Ta metoda nie jest zaimplementowana dla elementu PipelineRun. |
complete |
Oznacz przebieg potoku jako ukończony. Ta metoda nie jest zaimplementowana dla elementu 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 elementu 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 |
Pobieranie przebiegu potoku na podstawie identyfikatora przebiegu. |
get_graph |
Pobierz graf uruchomienia 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 uruchomienia potoku z usługi. Zwracane typowe 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 |
Opublikuj potok i udostępnij 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 trwający przebieg.
cancel()
child_run
Utwórz podrzędne uruchomienie dla uruchomienia potoku. Ta metoda nie jest zaimplementowana dla elementu PipelineRun.
child_run(name=None, run_id=None, outputs=None)
Parametry
- run_id
- str
Opcjonalny identyfikator przebiegu dla elementu podrzędnego, w przeciwnym razie używa wartości domyślnej.
- outputs
- str
Opcjonalny katalog danych wyjściowych do śledzenia dla elementu podrzędnego.
Zwraca
Przebieg podrzędny.
Typ zwracany
Wyjątki
complete
Oznacz przebieg potoku jako ukończony. Ta metoda nie jest zaimplementowana dla elementu 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
fail
Oznacz przebieg potoku jako niepowodzenie. Ta metoda nie jest zaimplementowana dla elementu 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
find_step_run
Znajdź przebieg kroku w potoku według nazwy.
find_step_run(name)
Parametry
Zwraca
StepRun Lista obiektów o podanej nazwie.
Typ zwracany
get
Pobieranie przebiegu potoku na podstawie identyfikatora przebiegu.
static get(workspace, run_id, _service_endpoint=None)
Parametry
Zwraca
Obiekt PipelineRun.
Typ zwracany
get_graph
get_pipeline_output
Pobierz wartość PortDataReference dla danych wyjściowych danego potoku.
get_pipeline_output(pipeline_output_name)
Parametry
Zwraca
Wartość PortDataReference reprezentująca dane wyjściowe potoku.
Typ zwracany
get_pipeline_runs
Pobierz uruchomienia potoku wygenerowane na podstawie opublikowanego potoku.
static get_pipeline_runs(workspace, pipeline_id, _service_endpoint=None)
Parametry
Zwraca
Lista PipelineRun obiektów.
Typ zwracany
get_status
Pobierz najnowszy stan uruchomienia potoku z usługi.
Zwracane typowe wartości to "Running", "Finished" i "Failed".
get_status()
Zwraca
Najnowszy stan jako ciąg.
Typ zwracany
Uwagi
NotStarted — jest to tymczasowy stan obiektów uruchomień po stronie klienta przed przesłaniem do chmury
Uruchomione — 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
get_tags
Pobierz zestaw tagów dla przebiegu.
get_tags()
Zwraca
Słownik tagów dla przebiegu.
Typ zwracany
publish_pipeline
Opublikuj potok i udostępnij 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
- continue_on_step_failure
- bool
Czy kontynuować wykonywanie innych kroków w potokuUruchom, jeśli krok zakończy się niepowodzeniem. Wartość domyślna to False.
- kwargs
- dict
Niestandardowe argumenty słów kluczowych zarezerwowane do przyszłego programowania
Zwraca
Utworzono opublikowany potok.
Typ zwracany
save
Zapisz potok YAML w pliku.
save(path=None)
Parametry
- 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.
Typ zwracany
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
Wskazuje, czy stan uruchomienia potoku ma być wyświetlany w pliku sys.stdout.
- timeout_seconds
- int
Liczba sekund oczekiwania przed przekroczeniem limitu czasu.
- raise_on_error
- bool
Wskazuje, czy zgłaszać błąd, gdy przebieg jest w stanie niepowodzenia.
Zwraca
Stan końcowy.
Typ zwracany
Opinia
https://aka.ms/ContentUserFeedback.
Dostępne już wkrótce: W 2024 r. będziemy stopniowo wycofywać zgłoszenia z serwisu GitHub jako mechanizm przesyłania opinii na temat zawartości i zastępować go nowym systemem opinii. Aby uzyskać więcej informacji, sprawdź:Prześlij i wyświetl opinię dla