StepRun Klasa

  • Odwołanie

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
Run
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

Nazwa Opis
experiment
Wymagane
Experiment

Obiekt eksperymentu przebiegu kroku.
step_run_id
Wymagane
str

Identyfikator przebiegu kroku.
pipeline_run_id
Wymagane
str

Identyfikator przebiegu przebiegu nadrzędnego potoku.
node_id
Wymagane
str

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

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

wartość domyślna: None
_is_reused
bool

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

wartość domyślna: False
_current_node_id
str

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

wartość domyślna: None
_reused_run_id
str

Ponownie użyty identyfikator przebiegu.

wartość domyślna: None
_reused_node_id
str

Ponownie użyty identyfikator węzła.

wartość domyślna: None
_reused_pipeline_run_id
str

Identyfikator ponownie użytego potoku.

wartość domyślna: None
experiment
Wymagane
Experiment

Obiekt eksperymentu przebiegu kroku.
step_run_id
Wymagane
str

Identyfikator przebiegu kroku.
pipeline_run_id
Wymagane
str

Identyfikator przebiegu przebiegu nadrzędnego potoku.
node_id
Wymagane
str

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

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

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

W przypadku ponownie użytego węzła identyfikator węzła na bieżącym grafie.
_reused_run_id
Wymagane
_reused_node_id
Wymagane
str
_reused_pipeline_run_id
Wymagane
str

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

Nazwa Opis
name
str

Opcjonalna nazwa elementu podrzędnego

wartość domyślna: None
run_id
str

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

wartość domyślna: None
outputs
str

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

wartość domyślna: None

Zwraca

Typ Opis
Run

Przebieg podrzędny

Wyjątki

Typ Opis
NotImplementedError

complete

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

complete()

Wyjątki

Typ Opis
NotImplementedError

fail

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

fail()

Wyjątki

Typ Opis
NotImplementedError

get_details_with_logs

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

get_details_with_logs()

Zwraca

Typ Opis
dict

Zwraca stan przebiegu z zawartością pliku dziennika

Wyjątki

Typ Opis
NotImplementedError

get_job_log

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

get_job_log()

Zwraca

Typ Opis
str

Ciąg dziennika.

Wyjątki

Typ Opis
NotImplementedError

get_output

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

get_output(name)

Parametry

Nazwa Opis
name
Wymagane
str

Nazwa danych wyjściowych.

Zwraca

Typ Opis
StepRunOutput

StepRunOutput o podanej nazwie.

Wyjątki

Typ Opis
NotImplementedError

get_output_data

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

get_output_data(name)

Parametry

Nazwa Opis
name
Wymagane
str

Nazwa danych wyjściowych.

Zwraca

Typ Opis
PortDataReference

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

Wyjątki

Typ Opis
NotImplementedError

get_outputs

Pobierz dane wyjściowe kroku.

get_outputs()

Zwraca

Typ Opis
dict

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

Wyjątki

Typ Opis
NotImplementedError

get_status

Pobierz najnowszy stan uruchomienia potoku z usługi.

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

get_status()

Zwraca

Typ Opis
str

Najnowszy stan jako ciąg

Wyjątki

Typ Opis
NotImplementedError

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

Typ Opis
str

Ciąg dziennika.

Wyjątki

Typ Opis
NotImplementedError

get_stdout_log

Zrzut bieżącego dziennika stdout dla przebiegu kroku.

get_stdout_log()

Zwraca

Typ Opis
str

Ciąg dziennika.

Wyjątki

Typ Opis
NotImplementedError

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

Nazwa Opis
show_output
bool

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

wartość domyślna: True
timeout_seconds
int

Liczba sekund oczekiwania przed przekroczeniem limitu czasu.

wartość domyślna: 9223372036854775807
raise_on_error
bool

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

wartość domyślna: True

Zwraca

Typ Opis
str

Stan końcowy.

Wyjątki

Typ Opis
NotImplementedError

Atrybuty

pipeline_run_id

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

Zwraca

Typ Opis
str

Identyfikator potokuUruchom.