PipelineRun Classe

Rappresenta un'esecuzione di un Pipelineoggetto .

Questa classe può essere usata per gestire, controllare lo stato e recuperare i dettagli dell'esecuzione dopo l'invio di un'esecuzione della pipeline. Usare get_steps per recuperare gli StepRun oggetti creati dall'esecuzione della pipeline. Altri usi includono il recupero dell'oggetto Graph associato all'esecuzione della pipeline, il recupero dello stato dell'esecuzione della pipeline e l'attesa del completamento dell'esecuzione.

Inizializzare un'esecuzione della pipeline.

Ereditarietà

Run

PipelineRun

Costruttore

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

Parametri

experiment

Experiment

Necessario

Oggetto esperimento associato all'esecuzione della pipeline.

run_id

str

Necessario

ID di esecuzione dell'esecuzione della pipeline.

_service_endpoint

str

valore predefinito: None

Endpoint a cui connettersi.

experiment

Experiment

Necessario

Oggetto esperimento associato all'esecuzione della pipeline.

run_id

str

Necessario

ID di esecuzione dell'esecuzione della pipeline.

_service_endpoint

str

Necessario

Endpoint a cui connettersi.

Commenti

Un oggetto PipelineRun viene restituito quando si invia un Pipeline oggetto tramite submit. metodo di un Experimentoggetto . Per altre informazioni su come creare e inviare una pipeline, vedere : https://aka.ms/pl-first-pipeline.

È anche possibile creare un'istanza di PipelineRun con l'esecuzione inviata a e l'ID Experiment PipelineRun come indicato di seguito:

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

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

Quando si usa PipelineRun, usare:

• wait_for_completion per monitorare lo stato di esecuzione e facoltativamente eseguire i log di esecuzione.

• get_status per recuperare lo stato di esecuzione.

• cancel per annullare un pipelineRun in corso.

• get_steps per elencare i passaggi generati. PipelineRun genera un oggetto StepRun per ogni passaggio della pipeline.

Metodi

cancel	Annullare l'esecuzione in corso.
child_run	Creare un'esecuzione figlio per l'esecuzione della pipeline. Questo metodo non è implementato per PipelineRun.
complete	Contrassegnare l'esecuzione della pipeline come completata. Questo metodo non è implementato per PipelineRun. Questo metodo non è supportato per le pipeline; lo stato di completamento/errore viene gestito dal back-end di Azure ML.
fail	Contrassegnare l'esecuzione della pipeline come non riuscita. Questo metodo non è implementato per PipelineRun. Questo metodo non è supportato per le pipeline; lo stato di completamento/errore viene gestito dal back-end di Azure ML.
find_step_run	Trovare un passaggio eseguito nella pipeline in base al nome.
get	Recuperare un'esecuzione della pipeline in base a un ID esecuzione.
get_graph	Ottenere il grafico dell'esecuzione della pipeline.
get_pipeline_output	Ottenere PortDataReference per l'output della pipeline specificato.
get_pipeline_runs	Recuperare le esecuzioni della pipeline generate da una pipeline pubblicata.
get_status	Recuperare lo stato più recente dell'esecuzione della pipeline dal servizio. I valori comuni restituiti includono "Running", "Finished" e "Failed".
get_steps	Ottenere l'esecuzione del passaggio per tutti i passaggi della pipeline completati o avviati.
get_tags	Ottenere il set di tag per l'esecuzione.
publish_pipeline	Pubblicare una pipeline e renderla disponibile per la riesecuzione. È possibile ottenere l'endpoint della pipeline dall'oggetto PublishedPipeline restituito da questa funzione. Con l'endpoint della pipeline è possibile richiamare la pipeline da applicazioni esterne usando chiamate REST. Per informazioni su come eseguire l'autenticazione quando si chiamano gli endpoint REST, vedere https://aka.ms/pl-restep-auth. La pipeline originale associata all'esecuzione della pipeline viene usata come base per la pipeline pubblicata.
save	Salvare il file YAML della pipeline.
wait_for_completion	Attendere il completamento dell'esecuzione della pipeline. Restituisce lo stato dopo l'attesa.

cancel

Annullare l'esecuzione in corso.

cancel()

child_run

Creare un'esecuzione figlio per l'esecuzione della pipeline. Questo metodo non è implementato per PipelineRun.

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

Parametri

name

str

valore predefinito: None

Nome facoltativo per l'elemento figlio.

run_id

str

valore predefinito: None

L'ID di esecuzione facoltativo per l'elemento figlio usa in caso contrario l'impostazione predefinita.

outputs

str

valore predefinito: None

La directory di output facoltativa da tenere traccia per l'elemento figlio.

Restituisce

Esecuzione figlio.

Tipo restituito

Run

Eccezioni

NotImplementedError

complete

Contrassegnare l'esecuzione della pipeline come completata. Questo metodo non è implementato per PipelineRun.

Questo metodo non è supportato per le pipeline; lo stato di completamento/errore viene gestito dal back-end di Azure ML.

complete()

Eccezioni

NotImplementedError

fail

Contrassegnare l'esecuzione della pipeline come non riuscita. Questo metodo non è implementato per PipelineRun.

Questo metodo non è supportato per le pipeline; lo stato di completamento/errore viene gestito dal back-end di Azure ML.

fail()

Eccezioni

NotImplementedError

find_step_run

Trovare un passaggio eseguito nella pipeline in base al nome.

find_step_run(name)

Parametri

name

str

Necessario

Nome del passaggio da trovare.

Restituisce

Elenco di StepRun oggetti con il nome specificato.

Tipo restituito

list

get

Recuperare un'esecuzione della pipeline in base a un ID esecuzione.

static get(workspace, run_id, _service_endpoint=None)

Parametri

workspace

Workspace

Necessario

Area di lavoro associata alla pipeline.

run_id

str

Necessario

ID dell'esecuzione della pipeline.

_service_endpoint

str

valore predefinito: None

Endpoint a cui connettersi.

Restituisce

Oggetto PipelineRun.

Tipo restituito

PipelineRun

get_graph

Ottenere il grafico dell'esecuzione della pipeline.

get_graph()

Restituisce

Grafico.

Tipo restituito

Graph

get_pipeline_output

Ottenere PortDataReference per l'output della pipeline specificato.

get_pipeline_output(pipeline_output_name)

Parametri

pipeline_output_name

str

Necessario

Nome dell'output della pipeline da ottenere.

Restituisce

PortDataReference che rappresenta i dati di output della pipeline.

Tipo restituito

PortDataReference

get_pipeline_runs

Recuperare le esecuzioni della pipeline generate da una pipeline pubblicata.

static get_pipeline_runs(workspace, pipeline_id, _service_endpoint=None)

Parametri

workspace

Workspace

Necessario

Area di lavoro associata alla pipeline.

pipeline_id

str

Necessario

ID della pipeline pubblicata.

_service_endpoint

str

valore predefinito: None

Endpoint a cui connettersi.

Restituisce

Elenco di oggetti PipelineRun.

Tipo restituito

list

get_status

Recuperare lo stato più recente dell'esecuzione della pipeline dal servizio.

I valori comuni restituiti includono "Running", "Finished" e "Failed".

get_status()

Restituisce

Stato più recente come stringa.

Tipo restituito

str

Commenti

• NotStarted: si tratta di oggetti Run sul lato client di stato temporanei che si trovano prima dell'invio nel cloud

• In esecuzione: il processo è stato avviato per l'esecuzione nella destinazione di calcolo.

• Non riuscito: l'esecuzione non è riuscita. In genere la proprietà Error in un'esecuzione fornirà informazioni dettagliate sul motivo.

• Completato: l'esecuzione è stata completata correttamente.

• Annullata: dopo la richiesta di annullamento, l'esecuzione viene annullata.

   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

Ottenere l'esecuzione del passaggio per tutti i passaggi della pipeline completati o avviati.

get_steps()

Restituisce

Elenco di oggetti StepRun.

Tipo restituito

list

get_tags

Ottenere il set di tag per l'esecuzione.

get_tags()

Restituisce

Dizionario dei tag per l'esecuzione.

Tipo restituito

dict

publish_pipeline

Pubblicare una pipeline e renderla disponibile per la riesecuzione.

È possibile ottenere l'endpoint della pipeline dall'oggetto PublishedPipeline restituito da questa funzione. Con l'endpoint della pipeline è possibile richiamare la pipeline da applicazioni esterne usando chiamate REST. Per informazioni su come eseguire l'autenticazione quando si chiamano gli endpoint REST, vedere https://aka.ms/pl-restep-auth.

La pipeline originale associata all'esecuzione della pipeline viene usata come base per la pipeline pubblicata.

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

Parametri

name

str

Necessario

Nome della pipeline pubblicata.

description

str

Necessario

Descrizione della pipeline pubblicata.

version

str

Necessario

Versione della pipeline pubblicata.

continue_on_step_failure

bool

valore predefinito: None

Indica se continuare l'esecuzione di altri passaggi in PipelineRun se un passaggio ha esito negativo. Il valore predefinito è False.

kwargs

dict

Necessario

Argomenti di parole chiave personalizzati, riservati per lo sviluppo futuro

Restituisce

È stata creata una pipeline pubblicata.

Tipo restituito

PublishedPipeline

save

Salvare il file YAML della pipeline.

save(path=None)

Parametri

path

str

valore predefinito: None

Percorso in cui salvare il file YAML. Se il percorso è una directory, il file YAML della pipeline viene salvato in <path>/pipeline.yml. Se il percorso non è nessuno, viene utilizzata la directory corrente.

Tipo restituito

None

wait_for_completion

Attendere il completamento dell'esecuzione della pipeline.

Restituisce lo stato dopo l'attesa.

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

Parametri

show_output

bool

valore predefinito: True

Indica se visualizzare lo stato di esecuzione della pipeline in sys.stdout.

timeout_seconds

int

valore predefinito: 9223372036854775807

Numero di secondi di attesa prima del timeout.

raise_on_error

bool

valore predefinito: True

Indica se generare un errore quando l'esecuzione si trova in uno stato di errore.

Restituisce

Stato finale.

Tipo restituito

str