StepRun Třída
Spuštění kroku v .Pipeline
Tuto třídu je možné použít ke správě, kontrole stavu a načtení podrobností o spuštění, jakmile se nadřazené spuštění kanálu odešle a kanál odešle spuštění kroku.
Inicializujte spuštění kroku.
- Dědičnost
-
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
Name | Description |
---|---|
experiment
Vyžadováno
|
Objekt experimentu spuštění kroku. |
step_run_id
Vyžadováno
|
ID spuštění kroku. |
pipeline_run_id
Vyžadováno
|
ID spuštění nadřazeného kanálu. |
node_id
Vyžadováno
|
ID uzlu v grafu, který představuje tento krok. |
_service_endpoint
|
Koncový bod, ke kterému se chcete připojit. Default value: None
|
_is_reused
|
Určuje, jestli se jedná o opakované předchozí spuštění. Default value: False
|
_current_node_id
|
U opakovaně používaného uzlu id uzlu v aktuálním grafu. Default value: None
|
_reused_run_id
|
ID opakovaného spuštění. Default value: None
|
_reused_node_id
|
Znovu použité ID uzlu. Default value: None
|
_reused_pipeline_run_id
|
Znovu použité ID kanálu. Default value: None
|
experiment
Vyžadováno
|
Objekt experimentu spuštění kroku. |
step_run_id
Vyžadováno
|
ID spuštění kroku. |
pipeline_run_id
Vyžadováno
|
ID spuštění nadřazeného kanálu. |
node_id
Vyžadováno
|
ID uzlu v grafu, který představuje tento krok. |
_service_endpoint
Vyžadováno
|
Koncový bod, ke kterému se chcete připojit. |
_is_reused
Vyžadováno
|
Určuje, jestli se jedná o opakované předchozí spuštění. |
_current_node_id
Vyžadováno
|
U opakovaně používaného uzlu id uzlu v aktuálním grafu. |
_reused_run_id
Vyžadováno
|
|
_reused_node_id
Vyžadováno
|
|
_reused_pipeline_run_id
Vyžadováno
|
|
Poznámky
StepRun se vytvoří jako podřízené spuštění odeslaného PipelineRunobjektu . Načtěte všechna spuštění kroků v kanáluSpustit následujícím způsobem:
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()
Slouží get_details_with_logs k načtení podrobností o spuštění a protokolů vytvořených spuštěním.
StepRun se dá použít také ke stažení výstupů spuštění. Slouží get_outputs k načtení diktování výstupů kroku nebo k get_output načtení jediného StepRunOutput objektu výstupu se zadaným názvem. Můžete také použít get_output_data k přímému načtení výstupu PortDataReference zadaného kroku.
Příklad stažení výstupu kroku je následující:
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 |
Podřízené spuštění kroku. Tato metoda není implementována pro StepRun. |
complete |
Dokončete spuštění kroku. Tato metoda není implementována pro StepRun. |
fail |
Selhání při spuštění kroku Tato metoda není implementována pro StepRun. |
get_details_with_logs |
Vrátí podrobnosti o stavu spuštění s obsahem souboru protokolu. |
get_job_log |
Výpis aktuálního protokolu úloh pro spuštění kroku |
get_output |
Získejte výstup uzlu s daným názvem. |
get_output_data |
Získejte výstupní data z daného výstupu. |
get_outputs |
Získejte výstupy kroků. |
get_status |
Načtěte ze služby nejnovější stav spuštění kanálu. Mezi běžné vrácené hodnoty patří Running (Spuštěno), Finished (Dokončeno) a Failed (Selhání). |
get_stderr_log |
Výpis aktuálního protokolu stderr pro spuštění kroku |
get_stdout_log |
Výpis aktuálního protokolu stdout pro spuštění kroku |
wait_for_completion |
Počkejte na dokončení tohoto kroku. Vrátí stav po čekání. |
child_run
Podřízené spuštění kroku. Tato metoda není implementována pro StepRun.
child_run(name=None, run_id=None, outputs=None)
Parametry
Name | Description |
---|---|
name
|
Volitelný název pro dítě Default value: None
|
run_id
|
Volitelné run_id pro podřízenou položku, jinak se použije výchozí hodnota. Default value: None
|
outputs
|
Volitelný adresář výstupů, který se má sledovat pro podřízenou složku Default value: None
|
Návraty
Typ | Description |
---|---|
Podřízené spuštění |
Výjimky
Typ | Description |
---|---|
complete
Dokončete spuštění kroku. Tato metoda není implementována pro StepRun.
complete()
Výjimky
Typ | Description |
---|---|
fail
Selhání při spuštění kroku Tato metoda není implementována pro StepRun.
fail()
Výjimky
Typ | Description |
---|---|
get_details_with_logs
Vrátí podrobnosti o stavu spuštění s obsahem souboru protokolu.
get_details_with_logs()
Návraty
Typ | Description |
---|---|
Vrátí stav spuštění s obsahem souboru protokolu. |
Výjimky
Typ | Description |
---|---|
get_job_log
Výpis aktuálního protokolu úloh pro spuštění kroku
get_job_log()
Návraty
Typ | Description |
---|---|
Řetězec protokolu. |
Výjimky
Typ | Description |
---|---|
get_output
Získejte výstup uzlu s daným názvem.
get_output(name)
Parametry
Name | Description |
---|---|
name
Vyžadováno
|
Název výstupu. |
Návraty
Typ | Description |
---|---|
StepRunOutput se zadaným názvem. |
Výjimky
Typ | Description |
---|---|
get_output_data
Získejte výstupní data z daného výstupu.
get_output_data(name)
Parametry
Name | Description |
---|---|
name
Vyžadováno
|
Název výstupu. |
Návraty
Typ | Description |
---|---|
PortDataReference představující výstupní data kroku. |
Výjimky
Typ | Description |
---|---|
get_outputs
Získejte výstupy kroků.
get_outputs()
Návraty
Typ | Description |
---|---|
Slovník StepRunOutputs s názvem výstupu jako klíčem. |
Výjimky
Typ | Description |
---|---|
get_status
Načtěte ze služby nejnovější stav spuštění kanálu.
Mezi běžné vrácené hodnoty patří Running (Spuštěno), Finished (Dokončeno) a Failed (Selhání).
get_status()
Návraty
Typ | Description |
---|---|
Nejnovější stav jako řetězec |
Výjimky
Typ | Description |
---|---|
Poznámky
NotStarted – jedná se o dočasný stav objektů spuštění na straně klienta, které jsou v před odesláním do cloudu.
Ve frontě – úloha je zařazená do fronty.
Spuštěno – Úloha se začala spouštět v cílovém výpočetním objektu.
Neúspěšné – spuštění se nezdařilo. Vlastnost Error při spuštění obvykle obsahuje podrobné informace o tom, proč tomu tak je.
Dokončeno – Spuštění bylo úspěšně dokončeno.
Zrušeno – po žádosti o zrušení se teď spuštění úspěšně zrušilo.
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
Výpis aktuálního protokolu stderr pro spuštění kroku
get_stderr_log()
Návraty
Typ | Description |
---|---|
Řetězec protokolu. |
Výjimky
Typ | Description |
---|---|
get_stdout_log
Výpis aktuálního protokolu stdout pro spuštění kroku
get_stdout_log()
Návraty
Typ | Description |
---|---|
Řetězec protokolu. |
Výjimky
Typ | Description |
---|---|
wait_for_completion
Počkejte na dokončení tohoto kroku.
Vrátí stav po čekání.
wait_for_completion(show_output=True, timeout_seconds=9223372036854775807, raise_on_error=True)
Parametry
Name | Description |
---|---|
show_output
|
show_output=True zobrazuje stav spuštění kanálu v sys.stdout. Default value: True
|
timeout_seconds
|
Počet sekund čekání před vypršením časového limitu Default value: 9223372036854775807
|
raise_on_error
|
Určuje, jestli se má vyvolat chyba, když je spuštění ve stavu selhání. Default value: True
|
Návraty
Typ | Description |
---|---|
Konečný stav. |
Výjimky
Typ | Description |
---|---|