StepRun Klasa

Uruchomienie kroku w obiekcie Pipeline.

Ta klasa może służyć do zarządzania, sprawdzania stanu i pobierania szczegółów przebiegu po przesłaniu uruchomienia potoku nadrzędnego, a potok przesłał przebieg kroku.

Inicjowanie krokuUruchomienie.

Dziedziczenie
StepRun

Konstruktor

StepRun(experiment, step_run_id, pipeline_run_id, node_id, _service_endpoint=None, _is_reused=False, _current_node_id=None, _reused_run_id=None, _reused_node_id=None, _reused_pipeline_run_id=None, **kwargs)

Parametry

experiment
Experiment
Wymagane

Obiekt eksperymentu przebiegu kroku.

step_run_id
str
Wymagane

Identyfikator przebiegu kroku.

pipeline_run_id
str
Wymagane

Identyfikator przebiegu przebiegu nadrzędnego potoku.

node_id
str
Wymagane

Identyfikator węzła na grafie, który reprezentuje ten krok.

_service_endpoint
str
wartość domyślna: None

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

_is_reused
bool
wartość domyślna: False

Wskazuje, czy ten przebieg jest ponownie używany w poprzednim przebiegu.

_current_node_id
str
wartość domyślna: None

W przypadku ponownie użytego węzła identyfikator węzła na bieżącym grafie.

_reused_run_id
str
wartość domyślna: None

Ponownie użyty identyfikator przebiegu.

_reused_node_id
str
wartość domyślna: None

Ponownie użyty identyfikator węzła.

_reused_pipeline_run_id
str
wartość domyślna: None

Identyfikator ponownie użytego potoku.

experiment
Experiment
Wymagane

Obiekt eksperymentu przebiegu kroku.

step_run_id
str
Wymagane

Identyfikator przebiegu kroku.

pipeline_run_id
str
Wymagane

Identyfikator przebiegu przebiegu nadrzędnego potoku.

node_id
str
Wymagane

Identyfikator węzła na grafie, który reprezentuje ten krok.

_service_endpoint
str
Wymagane

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

_is_reused
bool
Wymagane

Wskazuje, czy ten przebieg jest ponownie używany w poprzednim przebiegu.

_current_node_id
str
Wymagane

W przypadku ponownie użytego węzła identyfikator węzła na bieżącym grafie.

_reused_run_id
Wymagane
_reused_node_id
str
Wymagane
_reused_pipeline_run_id
str
Wymagane

Uwagi

KrokUruchomienie jest tworzone jako podrzędne uruchomienie przesłanego PipelineRunelementu . Pobierz wszystkie uruchomienia kroków w elemecie 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>")
   step_runs = pipeline_run.get_steps()

Użyj polecenia get_details_with_logs , aby pobrać szczegóły przebiegu i dzienniki utworzone przez przebieg.

Polecenie StepRun może również służyć do pobierania danych wyjściowych przebiegu. Użyj get_outputs polecenia , aby pobrać dykt danych wyjściowych kroku lub użyć get_output polecenia , aby pobrać pojedynczy StepRunOutput obiekt dla danych wyjściowych z podaną nazwą. Można również użyć get_output_data polecenia , aby pobrać dane PortDataReference wyjściowe dla określonego kroku bezpośrednio.

Przykład pobierania danych wyjściowych kroku jest następujący:


   from azureml.pipeline.core import PipelineRun, StepRun, PortDataReference

   pipeline_run = PipelineRun(experiment, "<pipeline_run_id>")
   step_run = pipeline_run.find_step_run("<step_name>")[0]
   port_data_reference = step_run.get_output_data("<output_name>")
   port_data_reference.download(local_path="path")

Metody

child_run

Podrzędne uruchomienie dla przebiegu kroku. Ta metoda nie jest zaimplementowana dla metody StepRun.

complete

Ukończ przebieg kroku. Ta metoda nie jest zaimplementowana dla metody StepRun.

fail

Niepowodzenie dla przebiegu kroku. Ta metoda nie jest zaimplementowana dla metody StepRun.

get_details_with_logs

Zwróć szczegóły stanu przebiegu z zawartością pliku dziennika.

get_job_log

Zrzuć bieżący dziennik zadań dla przebiegu kroku.

get_output

Pobierz dane wyjściowe węzła o podanej nazwie.

get_output_data

Pobierz dane wyjściowe z danych wyjściowych danych wyjściowych.

get_outputs

Pobierz dane wyjściowe kroku.

get_status

Pobierz najnowszy stan uruchomienia potoku z usługi.

Zwracane typowe wartości to "Running", "Finished" i "Failed".

get_stderr_log

Zrzuć bieżący dziennik stderr dla przebiegu kroku.

get_stdout_log

Zrzut bieżącego dziennika stdout dla przebiegu kroku.

wait_for_completion

Poczekaj na ukończenie tego kroku.

Zwraca stan po oczekiwaniu.

child_run

Podrzędne uruchomienie dla przebiegu kroku. Ta metoda nie jest zaimplementowana dla metody StepRun.

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

Opcjonalne run_id dla elementu podrzędnego. W przeciwnym razie zostanie użyta wartość domyślna

outputs
str
wartość domyślna: None

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

Zwraca

Przebieg podrzędny

Typ zwracany

Run

Wyjątki

complete

Ukończ przebieg kroku. Ta metoda nie jest zaimplementowana dla metody StepRun.

complete()

Wyjątki

fail

Niepowodzenie dla przebiegu kroku. Ta metoda nie jest zaimplementowana dla metody StepRun.

fail()

Wyjątki

get_details_with_logs

Zwróć szczegóły stanu przebiegu z zawartością pliku dziennika.

get_details_with_logs()

Zwraca

Zwraca stan przebiegu z zawartością pliku dziennika

Typ zwracany

Wyjątki

get_job_log

Zrzuć bieżący dziennik zadań dla przebiegu kroku.

get_job_log()

Zwraca

Ciąg dziennika.

Typ zwracany

str

Wyjątki

get_output

Pobierz dane wyjściowe węzła o podanej nazwie.

get_output(name)

Parametry

name
str
Wymagane

Nazwa danych wyjściowych.

Zwraca

StepRunOutput o podanej nazwie.

Typ zwracany

Wyjątki

get_output_data

Pobierz dane wyjściowe z danych wyjściowych danych wyjściowych.

get_output_data(name)

Parametry

name
str
Wymagane

Nazwa danych wyjściowych.

Zwraca

Wartość PortDataReference reprezentująca dane wyjściowe kroku.

Typ zwracany

Wyjątki

get_outputs

Pobierz dane wyjściowe kroku.

get_outputs()

Zwraca

Słownik StepRunOutputs z nazwą wyjściową jako kluczem.

Typ zwracany

Wyjątki

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

str

Wyjątki

Uwagi

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

  • W kolejce — zadanie jest w kolejce.

  • 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_stderr_log

Zrzuć bieżący dziennik stderr dla przebiegu kroku.

get_stderr_log()

Zwraca

Ciąg dziennika.

Typ zwracany

str

Wyjątki

get_stdout_log

Zrzut bieżącego dziennika stdout dla przebiegu kroku.

get_stdout_log()

Zwraca

Ciąg dziennika.

Typ zwracany

str

Wyjątki

wait_for_completion

Poczekaj na ukończenie tego kroku.

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

show_output=True pokazuje stan uruchomienia potoku w pliku sys.stdout.

timeout_seconds
int
wartość domyślna: 9223372036854775807

Liczba sekund oczekiwania przed przekroczeniem limitu czasu.

raise_on_error
bool
wartość domyślna: True

Wskazuje, czy zgłaszać błąd, gdy przebieg jest w stanie niepowodzenia

Zwraca

Stan końcowy.

Typ zwracany

str

Wyjątki

Atrybuty

pipeline_run_id

Zwróć identyfikator uruchomienia potoku odpowiadającego temu uruchomieniu kroku.

Zwraca

Identyfikator potokuUruchom.

Typ zwracany

str