Delen via

PipelineRun Klas

  • Referentie

Vertegenwoordigt een uitvoering van een Pipeline.

Deze klasse kan worden gebruikt voor het beheren, controleren van de status en het ophalen van uitvoeringsdetails zodra een pijplijnuitvoering is verzonden. Gebruik get_steps om de StepRun objecten op te halen die door de pijplijnuitvoering worden gemaakt. Andere toepassingen zijn het ophalen van het Graph object dat is gekoppeld aan de pijplijnuitvoering, het ophalen van de status van de pijplijnuitvoering en wachten op voltooiing van de uitvoering.

Initialiseer een pijplijnuitvoering.

Overname
Run
PipelineRun

Constructor

PipelineRun(experiment, run_id, _service_endpoint=None, **kwags)

Parameters

Name Description
experiment
Vereist
Experiment

Het experimentobject dat is gekoppeld aan de pijplijnuitvoering.
run_id
Vereist
str

De uitvoerings-id van de pijplijnuitvoering.
_service_endpoint
str

Het eindpunt waarmee u verbinding wilt maken.

Default value: None
experiment
Vereist
Experiment

Het experimentobject dat is gekoppeld aan de pijplijnuitvoering.
run_id
Vereist
str

De uitvoerings-id van de pijplijnuitvoering.
_service_endpoint
Vereist
str

Het eindpunt waarmee u verbinding wilt maken.

Opmerkingen

Een PipelineRun-object wordt geretourneerd bij het verzenden van een Pipeline via de submit. van een Experiment. Zie voor meer informatie over het maken en verzenden van een pijplijn: https://aka.ms/pl-first-pipeline.

Een PipelineRun kan ook als volgt worden geïnstantieerd met de Experiment uitvoering die is verzonden naar en de PipelineRun-id:


   from azureml.core import Experiment
   from azureml.pipeline.core import PipelineRun

   experiment = Experiment(workspace, "<experiment_name>")
   pipeline_run = PipelineRun(experiment, "<pipeline_run_id>")

Wanneer u met PipelineRun werkt, gebruikt u het volgende:

  • wait_for_completion om de uitvoeringsstatus te bewaken en optioneel uitvoeringslogboeken te streamen.

  • get_status om de uitvoeringsstatus op te halen.

  • cancel om een lopende PipelineRun te annuleren.

  • get_steps om de gegenereerde StepRuns weer te geven. Een PipelineRun genereert een StepRun voor elke stap in de pijplijn.

Methoden

cancel

Annuleer de lopende uitvoering.
child_run

Maak een onderliggende uitvoering voor de pijplijnuitvoering. Deze methode is niet geïmplementeerd voor PipelineRun.
complete

Markeer de pijplijnuitvoering als voltooid. Deze methode is niet geïmplementeerd voor PipelineRun.

Deze methode wordt niet ondersteund voor pijplijnen; de status voltooiing/mislukt wordt beheerd door de Azure ML-back-end.
fail

Markeer de uitvoering van de pijplijn als mislukt. Deze methode is niet geïmplementeerd voor PipelineRun.

Deze methode wordt niet ondersteund voor pijplijnen; de status voltooiing/mislukt wordt beheerd door de Azure ML-back-end.
find_step_run

Zoek een stapuitvoering in de pijplijn op naam.
get

Haal een pijplijnuitvoering op op basis van een uitvoerings-id.
get_graph

Haal de grafiek van de pijplijnuitvoering op.
get_pipeline_output

Haal de PortDataReference op voor de opgegeven pijplijnuitvoer.
get_pipeline_runs

Haal de pijplijnuitvoeringen op die zijn gegenereerd op basis van een gepubliceerde pijplijn.
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_steps

Haal de stapuitvoeringen op voor alle pijplijnstappen die zijn voltooid of gestart.
get_tags

Haal de set tags voor de uitvoering op.
publish_pipeline

Publiceer een pijplijn en maak deze beschikbaar voor opnieuw uitvoeren.

U kunt het pijplijneindpunt ophalen uit het object PublishedPipeline dat door deze functie wordt geretourneerd. Met het pijplijneindpunt kunt u de pijplijn aanroepen vanuit externe toepassingen met behulp van REST-aanroepen. Zie voor meer informatie over het verifiëren bij het aanroepen van REST-eindpunten https://aka.ms/pl-restep-auth.

De oorspronkelijke pijplijn die is gekoppeld aan de pijplijnuitvoering, wordt gebruikt als basis voor de gepubliceerde pijplijn.
save

Sla de YAML van de pijplijn op in een bestand.
wait_for_completion

Wacht tot de uitvoering van deze pijplijn is voltooid.

Retourneert de status na de wachttijd.

cancel

Annuleer de lopende uitvoering.

cancel()

child_run

Maak een onderliggende uitvoering voor de pijplijnuitvoering. Deze methode is niet geïmplementeerd voor PipelineRun.

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 uitvoerings-id voor het onderliggende item, anders wordt de standaardwaarde gebruikt.

Default value: None
outputs
str

Optionele uitvoermap die moet worden bijgehouden voor het onderliggende item.

Default value: None

Retouren

Type Description
Run

Het kind wordt uitgevoerd.

Uitzonderingen

Type Description
NotImplementedError

complete

Markeer de pijplijnuitvoering als voltooid. Deze methode is niet geïmplementeerd voor PipelineRun.

Deze methode wordt niet ondersteund voor pijplijnen; de status voltooiing/mislukt wordt beheerd door de Azure ML-back-end.

complete()

Uitzonderingen

Type Description
NotImplementedError

fail

Markeer de uitvoering van de pijplijn als mislukt. Deze methode is niet geïmplementeerd voor PipelineRun.

Deze methode wordt niet ondersteund voor pijplijnen; de status voltooiing/mislukt wordt beheerd door de Azure ML-back-end.

fail()

Uitzonderingen

Type Description
NotImplementedError

find_step_run

Zoek een stapuitvoering in de pijplijn op naam.

find_step_run(name)

Parameters

Name Description
name
Vereist
str

De naam van de stap die moet worden gevonden.

Retouren

Type Description
list

StepRun Lijst met objecten met de opgegeven naam.

get

Haal een pijplijnuitvoering op op basis van een uitvoerings-id.

static get(workspace, run_id, _service_endpoint=None)

Parameters

Name Description
workspace
Vereist
Workspace

De werkruimte die is gekoppeld aan de pijplijn.
run_id
Vereist
str

De id van de pijplijnuitvoering.
_service_endpoint
str

Het eindpunt waarmee u verbinding wilt maken.

Default value: None

Retouren

Type Description
PipelineRun

Het PipelineRun object.

get_graph

Haal de grafiek van de pijplijnuitvoering op.

get_graph()

Retouren

Type Description
Graph

De grafiek.

get_pipeline_output

Haal de PortDataReference op voor de opgegeven pijplijnuitvoer.

get_pipeline_output(pipeline_output_name)

Parameters

Name Description
pipeline_output_name
Vereist
str

De naam van de pijplijnuitvoer die u wilt ophalen.

Retouren

Type Description
PortDataReference

De PortDataReference die de uitvoergegevens van de pijplijn vertegenwoordigt.

get_pipeline_runs

Haal de pijplijnuitvoeringen op die zijn gegenereerd op basis van een gepubliceerde pijplijn.

static get_pipeline_runs(workspace, pipeline_id, _service_endpoint=None)

Parameters

Name Description
workspace
Vereist
Workspace

De werkruimte die is gekoppeld aan de pijplijn.
pipeline_id
Vereist
str

De id van de gepubliceerde pijplijn.
_service_endpoint
str

Het eindpunt waarmee u verbinding wilt maken.

Default value: None

Retouren

Type Description
list

Een lijst met PipelineRun objecten.

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.

Opmerkingen

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

  • 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_steps

Haal de stapuitvoeringen op voor alle pijplijnstappen die zijn voltooid of gestart.

get_steps()

Retouren

Type Description
list

Een lijst met StepRun objecten.

get_tags

Haal de set tags voor de uitvoering op.

get_tags()

Retouren

Type Description
dict

De woordenlijst met tags voor de uitvoering.

publish_pipeline

Publiceer een pijplijn en maak deze beschikbaar voor opnieuw uitvoeren.

U kunt het pijplijneindpunt ophalen uit het object PublishedPipeline dat door deze functie wordt geretourneerd. Met het pijplijneindpunt kunt u de pijplijn aanroepen vanuit externe toepassingen met behulp van REST-aanroepen. Zie voor meer informatie over het verifiëren bij het aanroepen van REST-eindpunten https://aka.ms/pl-restep-auth.

De oorspronkelijke pijplijn die is gekoppeld aan de pijplijnuitvoering, wordt gebruikt als basis voor de gepubliceerde pijplijn.

publish_pipeline(name, description, version, continue_on_step_failure=None, **kwargs)

Parameters

Name Description
name
Vereist
str

De naam van de gepubliceerde pijplijn.
description
Vereist
str

De beschrijving van de gepubliceerde pijplijn.
version
Vereist
str

De versie van de gepubliceerde pijplijn.
continue_on_step_failure
bool

Of u wilt doorgaan met de uitvoering van andere stappen in de PipelineRun als een stap mislukt. De standaardwaarde is False.

Default value: None
kwargs
Vereist
dict

Aangepaste trefwoordargumenten, gereserveerd voor toekomstige ontwikkeling

Retouren

Type Description
PublishedPipeline

Gepubliceerde pijplijn gemaakt.

save

Sla de YAML van de pijplijn op in een bestand.

save(path=None)

Parameters

Name Description
path
str

Het pad om de YAML in op te slaan. Als het pad een map is, wordt het YAML-bestand van de pijplijn opgeslagen op <path>/pipeline.yml. Als het pad geen is, wordt de huidige map gebruikt.

Default value: None

Retouren

Type Description
None

wait_for_completion

Wacht tot de uitvoering van deze pijplijn 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

Geeft aan of de status van de pijplijnuitvoering op sys.stdout moet worden weergegeven.

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.