StepRun Klas

Een uitvoering van een stap in een Pipeline.

Deze klasse kan worden gebruikt voor het beheren, controleren van de status en het ophalen van uitvoeringsdetails zodra de bovenliggende pijplijn is verzonden en de pijplijn de stapuitvoering heeft verzonden.

Initialiseer een StepRun.

Overname

Run

StepRun

Constructor

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)

Parameters

Name	Description
experiment Vereist	Experiment Het experimentobject van de stapuitvoering.
step_run_id Vereist	str De uitvoerings-id van de stapuitvoering.
pipeline_run_id Vereist	str De uitvoerings-id van de bovenliggende pijplijnuitvoering.
node_id Vereist	str De id van het knooppunt in de grafiek die deze stap vertegenwoordigt.
_service_endpoint	str Het eindpunt waarmee u verbinding wilt maken. Default value: None
_is_reused	bool Geeft aan of deze uitvoering een hergebruikte vorige uitvoering is. Default value: False
_current_node_id	str Voor een opnieuw gebruikt knooppunt, de knooppunt-id in de huidige grafiek. Default value: None
_reused_run_id	str De opnieuw gebruikte uitvoerings-id. Default value: None
_reused_node_id	str De opnieuw gebruikte knooppunt-id. Default value: None
_reused_pipeline_run_id	str De opnieuw gebruikte pijplijn-id. Default value: None
experiment Vereist	Experiment Het experimentobject van de stapuitvoering.
step_run_id Vereist	str De uitvoerings-id van de stapuitvoering.
pipeline_run_id Vereist	str De uitvoerings-id van de bovenliggende pijplijnuitvoering.
node_id Vereist	str De id van het knooppunt in de grafiek die deze stap vertegenwoordigt.
_service_endpoint Vereist	str Het eindpunt waarmee u verbinding wilt maken.
_is_reused Vereist	bool Geeft aan of deze uitvoering een hergebruikte vorige uitvoering is.
_current_node_id Vereist	str Voor een opnieuw gebruikt knooppunt, de knooppunt-id in de huidige grafiek.
_reused_run_id Vereist
_reused_node_id Vereist	str
_reused_pipeline_run_id Vereist	str

Opmerkingen

Een StepRun wordt gemaakt als een onderliggende uitvoering van een verzonden PipelineRun. Haal alle StepRuns in een PipelineRun als volgt op:

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

Gebruik get_details_with_logs om de uitvoeringsdetails en logboeken op te halen die door de uitvoering zijn gemaakt.

StepRun kan ook worden gebruikt om de uitvoer van een uitvoering te downloaden. Gebruik get_outputs om een dict van de uitvoer van de stap op te halen of gebruik get_output om het ene StepRunOutput object voor de uitvoer op te halen met de opgegeven naam. U kunt ook gebruiken get_output_data om de voor de PortDataReference opgegeven stapuitvoer rechtstreeks op te halen.

Een voorbeeld van het downloaden van een stapuitvoer is als volgt:

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

Methoden

child_run	Onderliggende uitvoering voor stapuitvoering. Deze methode is niet geïmplementeerd voor StepRun.
complete	Voltooien voor het uitvoeren van de stap. Deze methode is niet geïmplementeerd voor StepRun.
fail	Mislukt voor het uitvoeren van de stap. Deze methode is niet geïmplementeerd voor StepRun.
get_details_with_logs	Retourneer de statusdetails van de uitvoering met de inhoud van het logboekbestand.
get_job_log	Dump het huidige taaklogboek voor de stapuitvoering.
get_output	Haal de knooppuntuitvoer op met de opgegeven naam.
get_output_data	Haal de uitvoergegevens op van een bepaalde uitvoer.
get_outputs	Haal de uitvoer van de stap op.
get_status	Haal de meest recente status van de pijplijnuitvoering op uit de service. Veelvoorkomende waarden die worden geretourneerd, zijn 'Wordt uitgevoerd', 'Voltooid' en 'Mislukt'.
get_stderr_log	Dump het huidige stderr-logboek voor de stapuitvoering.
get_stdout_log	Dump het huidige stdout-logboek voor de stapuitvoering.
wait_for_completion	Wacht tot de uitvoering van deze stap is voltooid. Retourneert de status na de wachttijd.

child_run

Onderliggende uitvoering voor stapuitvoering. Deze methode is niet geïmplementeerd voor StepRun.

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

Parameters

Name	Description
name	str Optionele naam voor het kind Default value: None
run_id	str Optionele run_id voor het kind, anders wordt standaard gebruikt Default value: None
outputs	str Optionele uitvoermap die moet worden bijgehouden voor het onderliggende item Default value: None

Retouren

Type	Description
Run	De onderliggende uitvoering

Uitzonderingen

Type	Description
NotImplementedError

complete

Voltooien voor het uitvoeren van de stap. Deze methode is niet geïmplementeerd voor StepRun.

complete()

Uitzonderingen

Type	Description
NotImplementedError

fail

Mislukt voor het uitvoeren van de stap. Deze methode is niet geïmplementeerd voor StepRun.

fail()

Uitzonderingen

Type	Description
NotImplementedError

get_details_with_logs

Retourneer de statusdetails van de uitvoering met de inhoud van het logboekbestand.

get_details_with_logs()

Retouren

Type	Description
dict	Retourneert de status voor de uitvoering met de inhoud van het logboekbestand

Uitzonderingen

Type	Description
NotImplementedError

get_job_log

Dump het huidige taaklogboek voor de stapuitvoering.

get_job_log()

Retouren

Type	Description
str	De logboektekenreeks.

Uitzonderingen

Type	Description
NotImplementedError

get_output

Haal de knooppuntuitvoer op met de opgegeven naam.

get_output(name)

Parameters

Name	Description
name Vereist	str Naam van de uitvoer.

Retouren

Type	Description
StepRunOutput	De StepRunOutput met de opgegeven naam.

Uitzonderingen

Type	Description
NotImplementedError

get_output_data

Haal de uitvoergegevens op van een bepaalde uitvoer.

get_output_data(name)

Parameters

Name	Description
name Vereist	str Naam van de uitvoer.

Retouren

Type	Description
PortDataReference	De PortDataReference die de uitvoergegevens van de stap vertegenwoordigt.

Uitzonderingen

Type	Description
NotImplementedError

get_outputs

Haal de uitvoer van de stap op.

get_outputs()

Retouren

Type	Description
dict	Een woordenlijst van StepRunOutputs met de uitvoernaam als sleutel.

Uitzonderingen

Type	Description
NotImplementedError

get_status

Haal de meest recente status van de pijplijnuitvoering op uit de service.

Veelvoorkomende waarden die worden geretourneerd, zijn 'Wordt uitgevoerd', 'Voltooid' en 'Mislukt'.

get_status()

Retouren

Type	Description
str	De meest recente status als tekenreeks

Uitzonderingen

Type	Description
NotImplementedError

Opmerkingen

• NotStarted : dit is een tijdelijke status waarin run-objecten zich aan clientzijde bevinden voordat ze in de cloud worden verzonden

• In wachtrij: de taak wordt in de wachtrij geplaatst.

• Uitvoeren: de taak wordt uitgevoerd in het rekendoel.

• Mislukt: de uitvoering is mislukt. Meestal geeft de eigenschap Error bij een uitvoering details over waarom.

• Voltooid: de uitvoering is voltooid.

• Geannuleerd: na een annuleringsaanvraag is de uitvoering nu geannuleerd.

   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

Dump het huidige stderr-logboek voor de stapuitvoering.

get_stderr_log()

Retouren

Type	Description
str	De logboektekenreeks.

Uitzonderingen

Type	Description
NotImplementedError

get_stdout_log

Dump het huidige stdout-logboek voor de stapuitvoering.

get_stdout_log()

Retouren

Type	Description
str	De logboektekenreeks.

Uitzonderingen

Type	Description
NotImplementedError

wait_for_completion

Wacht tot de uitvoering van deze stap is voltooid.

Retourneert de status na de wachttijd.

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

Parameters

Name	Description
show_output	bool show_output=True toont de status van de pijplijnuitvoering op sys.stdout. Default value: True
timeout_seconds	int Het aantal seconden dat moet worden gewacht voordat er een time-out optreedt. Default value: 9223372036854775807
raise_on_error	bool Geeft aan of er een fout moet worden gegenereerd wanneer de uitvoering de status Mislukt heeft Default value: True

Retouren

Type	Description
str	De uiteindelijke status.

Uitzonderingen

Type	Description
NotImplementedError

Kenmerken

pipeline_run_id

Retourneert de id van de pijplijnuitvoering die overeenkomt met deze stapuitvoering.

Retouren

Type	Description
str	De PipelineRun-id.