Share via

StepRun Třída

  • Reference

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 odešle nadřazené spuštění kanálu a kanál odešle krok.

Inicializace spuštění kroku

Dědičnost
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

Name Description
experiment
Vyžadováno
Experiment

Objekt experimentu spuštění kroku.
step_run_id
Vyžadováno
str

ID spuštění kroku.
pipeline_run_id
Vyžadováno
str

ID spuštění nadřazeného spuštění kanálu.
node_id
Vyžadováno
str

ID uzlu v grafu, které představuje tento krok.
_service_endpoint
str

Koncový bod, ke kterému se chcete připojit.

výchozí hodnota: None
_is_reused
bool

Určuje, jestli se jedná o opakované předchozí spuštění.

výchozí hodnota: False
_current_node_id
str

U opakovaně používaného uzlu id uzlu v aktuálním grafu.

výchozí hodnota: None
_reused_run_id
str

ID opakovaného spuštění.

výchozí hodnota: None
_reused_node_id
str

ID znovu použitého uzlu.

výchozí hodnota: None
_reused_pipeline_run_id
str

ID znovu použitého kanálu.

výchozí hodnota: None
experiment
Vyžadováno
Experiment

Objekt experimentu spuštění kroku.
step_run_id
Vyžadováno
str

ID spuštění kroku.
pipeline_run_id
Vyžadováno
str

ID spuštění nadřazeného spuštění kanálu.
node_id
Vyžadováno
str

ID uzlu v grafu, které představuje tento krok.
_service_endpoint
Vyžadováno
str

Koncový bod, ke kterému se chcete připojit.
_is_reused
Vyžadováno
bool

Určuje, jestli se jedná o opakované předchozí spuštění.
_current_node_id
Vyžadováno
str

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
str
_reused_pipeline_run_id
Vyžadováno
str

Poznámky

StepRun se vytvoří jako podřízené spuštění odeslaného PipelineRunobjektu . Načtěte všechna spuštění kroků v PipelineRun 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í. Použijte get_outputs k načtení diktu výstupu kroku nebo použijte get_output k načtení jednoho 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í pro spuštění kroku. Tato metoda není implementována pro StepRun.
complete

Dokončení pro 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

Vraťte 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 se zadaný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 nejnovější stav spuštění kanálu ze služby.

Mezi běžné vrácené hodnoty patří "Spuštěno", "Dokončeno" a "Selhání".
get_stderr_log

Výpis aktuálního protokolu stderru 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í pro spuštění kroku. Tato metoda není implementována pro StepRun.

child_run(name=None, run_id=None, outputs=None)

Parametry

Name Description
name
str

Volitelný název pro dítě

výchozí hodnota: None
run_id
str

Volitelné run_id pro podřízenou položku, jinak používá výchozí

výchozí hodnota: None
outputs
str

Volitelný adresář výstupů, který se má sledovat pro podřízenou složku

výchozí hodnota: None

Návraty

Typ Description
Run

Podřízené spuštění

Výjimky

Typ Description
NotImplementedError

complete

Dokončení pro spuštění kroku Tato metoda není implementována pro StepRun.

complete()

Výjimky

Typ Description
NotImplementedError

fail

Selhání při spuštění kroku Tato metoda není implementována pro StepRun.

fail()

Výjimky

Typ Description
NotImplementedError

get_details_with_logs

Vraťte podrobnosti o stavu spuštění s obsahem souboru protokolu.

get_details_with_logs()

Návraty

Typ Description
dict

Vrátí stav spuštění s obsahem souboru protokolu.

Výjimky

Typ Description
NotImplementedError

get_job_log

Výpis aktuálního protokolu úloh pro spuštění kroku

get_job_log()

Návraty

Typ Description
str

Řetězec protokolu.

Výjimky

Typ Description
NotImplementedError

get_output

Získejte výstup uzlu se zadaným názvem.

get_output(name)

Parametry

Name Description
name
Vyžadováno
str

Název výstupu.

Návraty

Typ Description
StepRunOutput

StepRunOutput se zadaným názvem.

Výjimky

Typ Description
NotImplementedError

get_output_data

Získejte výstupní data z daného výstupu.

get_output_data(name)

Parametry

Name Description
name
Vyžadováno
str

Název výstupu.

Návraty

Typ Description
PortDataReference

PortDataReference představující výstupní data kroku.

Výjimky

Typ Description
NotImplementedError

get_outputs

Získejte výstupy kroků.

get_outputs()

Návraty

Typ Description
dict

Slovník StepRunOutputs s názvem výstupu jako klíčem.

Výjimky

Typ Description
NotImplementedError

get_status

Načtěte nejnovější stav spuštění kanálu ze služby.

Mezi běžné vrácené hodnoty patří "Spuštěno", "Dokončeno" a "Selhání".

get_status()

Návraty

Typ Description
str

Nejnovější stav jako řetězec

Výjimky

Typ Description
NotImplementedError

Poznámky

  • NotStarted – jedná se o dočasný stav objektů spuštění na straně klienta 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.

  • Selhání – Spuštění se nezdařilo. Vlastnost Error při spuštění obvykle obsahuje podrobnosti o důvodech.

  • 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 stderru pro spuštění kroku.

get_stderr_log()

Návraty

Typ Description
str

Řetězec protokolu.

Výjimky

Typ Description
NotImplementedError

get_stdout_log

Výpis aktuálního protokolu stdout pro spuštění kroku

get_stdout_log()

Návraty

Typ Description
str

Řetězec protokolu.

Výjimky

Typ Description
NotImplementedError

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
bool

show_output=True zobrazuje stav spuštění kanálu na sys.stdout.

výchozí hodnota: True
timeout_seconds
int

Počet sekund čekání před vypršením časového limitu

výchozí hodnota: 9223372036854775807
raise_on_error
bool

Označuje, jestli se má vyvolat chyba, když je spuštění ve stavu selhání.

výchozí hodnota: True

Návraty

Typ Description
str

Konečný stav.

Výjimky

Typ Description
NotImplementedError

Atributy

pipeline_run_id

Vrátí ID spuštění kanálu odpovídající tomuto kroku.

Návraty

Typ Description
str

ID Spuštění kanálu.