StepRun Klass

En körning av ett steg i en Pipeline.

Den här klassen kan användas för att hantera, kontrollera status och hämta körningsinformation när den överordnade pipelinekörningen har skickats och pipelinen har skickat in stegkörningen.

Initiera en StepRun.

Arv

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)

Parametrar

experiment

Experiment

Obligatorisk

Experimentobjektet för stegkörningen.

step_run_id

str

Obligatorisk

Körnings-ID för stegkörningen.

pipeline_run_id

str

Obligatorisk

Körnings-ID för den överordnade pipelinekörningen.

node_id

str

Obligatorisk

ID:t för noden i diagrammet som representerar det här steget.

_service_endpoint

str

standardvärde: None

Slutpunkten att ansluta till.

_is_reused

bool

standardvärde: False

Anger om den här körningen är en återanvänd tidigare körning.

_current_node_id

str

standardvärde: None

För en återanvänd nod är nod-ID:t i den aktuella grafen.

_reused_run_id

str

standardvärde: None

Det återanvända kör-ID:t.

_reused_node_id

str

standardvärde: None

Det återanvända nod-ID:t.

_reused_pipeline_run_id

str

standardvärde: None

Det återanvända pipeline-ID:t.

experiment

Experiment

Obligatorisk

Experimentobjektet för stegkörningen.

step_run_id

str

Obligatorisk

Körnings-ID för stegkörningen.

pipeline_run_id

str

Obligatorisk

Körnings-ID för den överordnade pipelinekörningen.

node_id

str

Obligatorisk

ID:t för noden i diagrammet som representerar det här steget.

_service_endpoint

str

Obligatorisk

Slutpunkten att ansluta till.

_is_reused

bool

Obligatorisk

Anger om den här körningen är en återanvänd tidigare körning.

_current_node_id

str

Obligatorisk

För en återanvänd nod är nod-ID:t i den aktuella grafen.

_reused_run_id

Obligatorisk

_reused_node_id

str

Obligatorisk

_reused_pipeline_run_id

str

Obligatorisk

Kommentarer

En StepRun skapas som en underordnad körning av en skickad PipelineRun. Hämta alla StepRuns i en PipelineRun på följande sätt:

   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()

Använd get_details_with_logs för att hämta körningsinformationen och loggarna som skapats av körningen.

StepRun kan också användas för att ladda ned utdata från en körning. Använd get_outputs för att hämta en dikta av stegutdata, eller använd get_output för att hämta det enskilda StepRunOutput objektet för utdata med det angivna namnet. Du kan också använda get_output_data för att hämta PortDataReference för de angivna stegutdata direkt.

Ett exempel på hur du laddar ned ett stegs utdata är följande:

   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")

Metoder

child_run	Underordnad körning för stegkörning. Den här metoden implementeras inte för StepRun.
complete	Slutför för stegkörning. Den här metoden implementeras inte för StepRun.
fail	Misslyckas för stegkörning. Den här metoden implementeras inte för StepRun.
get_details_with_logs	Returnera statusinformationen för körningen med loggfilens innehåll.
get_job_log	Dumpa den aktuella jobbloggen för stegkörningen.
get_output	Hämta nodutdata med det angivna namnet.
get_output_data	Hämta utdata från en viss utdata.
get_outputs	Hämta stegutdata.
get_status	Hämta pipelinekörningens senaste status från tjänsten. Vanliga värden som returneras är "Running", "Finished" och "Failed".
get_stderr_log	Dumpa den aktuella stderr-loggen för stegkörningen.
get_stdout_log	Dumpa den aktuella stdout-loggen för stegkörningen.
wait_for_completion	Vänta tills det här steget har körts. Returnerar statusen efter väntetiden.

child_run

Underordnad körning för stegkörning. Den här metoden implementeras inte för StepRun.

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

Parametrar

name

str

standardvärde: None

Valfritt namn för det underordnade

run_id

str

standardvärde: None

Valfritt run_id för det underordnade, annars används standard

outputs

str

standardvärde: None

Valfri utdatakatalog som ska spåras för den underordnade

Returer

Den underordnade körningen

Returtyp

Run

Undantag

NotImplementedError

complete

Slutför för stegkörning. Den här metoden implementeras inte för StepRun.

complete()

Undantag

NotImplementedError

fail

Misslyckas för stegkörning. Den här metoden implementeras inte för StepRun.

fail()

Undantag

NotImplementedError

get_details_with_logs

Returnera statusinformationen för körningen med loggfilens innehåll.

get_details_with_logs()

Returer

Returnerar status för körningen med loggfilinnehåll

Returtyp

dict

Undantag

NotImplementedError

get_job_log

Dumpa den aktuella jobbloggen för stegkörningen.

get_job_log()

Returer

Loggsträngen.

Returtyp

str

Undantag

NotImplementedError

get_output

Hämta nodutdata med det angivna namnet.

get_output(name)

Parametrar

name

str

Obligatorisk

Namn på utdata.

Returer

StepRunOutput med det angivna namnet.

Returtyp

StepRunOutput

Undantag

NotImplementedError

get_output_data

Hämta utdata från en viss utdata.

get_output_data(name)

Parametrar

name

str

Obligatorisk

Namn på utdata.

Returer

PortDataReference som representerar stegets utdata.

Returtyp

PortDataReference

Undantag

NotImplementedError

get_outputs

Hämta stegutdata.

get_outputs()

Returer

En ordlista med StepRunOutputs med utdatanamnet som nyckel.

Returtyp

dict

Undantag

NotImplementedError

get_status

Hämta pipelinekörningens senaste status från tjänsten.

Vanliga värden som returneras är "Running", "Finished" och "Failed".

get_status()

Returer

Den senaste statusen som en sträng

Returtyp

str

Undantag

NotImplementedError

Kommentarer

• NotStarted – det här är ett tillfälligt tillstånd för körningsobjekt på klientsidan innan molnöverföring

• I kö – jobbet placeras i kö.

• Körs – jobbet började köras i beräkningsmålet.

• Misslyckades – körningen misslyckades. Vanligtvis innehåller egenskapen Error på en körning information om varför.

• Slutförd – körningen slutfördes.

• Avbruten – Efter en annulleringsbegäran avbryts körningen nu.

   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

Dumpa den aktuella stderr-loggen för stegkörningen.

get_stderr_log()

Returer

Loggsträngen.

Returtyp

str

Undantag

NotImplementedError

get_stdout_log

Dumpa den aktuella stdout-loggen för stegkörningen.

get_stdout_log()

Returer

Loggsträngen.

Returtyp

str

Undantag

NotImplementedError

wait_for_completion

Vänta tills det här steget har körts.

Returnerar statusen efter väntetiden.

wait_for_completion(show_output=True, timeout_seconds=9223372036854775807, raise_on_error=True)

Parametrar

show_output

bool

standardvärde: True

show_output=Sant visar status för pipelinekörning på sys.stdout.

timeout_seconds

int

standardvärde: 9223372036854775807

Antal sekunder att vänta innan tidsgränsen nås.

raise_on_error

bool

standardvärde: True

Anger om ett fel ska uppstå när körningen är i ett feltillstånd

Returer

Den slutliga statusen.

Returtyp

str

Undantag

NotImplementedError

Attribut

pipeline_run_id

Returnera ID:t för pipelinekörningen som motsvarar den här stegkörningen.

Returer

PipelineRun-ID:t.

Returtyp

str