PublishedPipeline Classe
Rappresenta una pipeline da inviare senza il codice Python che l'ha costruito.
Inoltre, è possibile usare un oggetto PublishedPipeline per inviare nuovamente un oggetto Pipeline con valori e input diversi PipelineParameter .
Inizializzare PublishedPipeline.
:p aram endpoint REST URL per inviare le esecuzioni della pipeline per questa pipeline. :type endpoint: str :p aram total_run_steps: numero di passaggi in questa pipeline :type total_run_steps: int :p aram area di lavoro: area di lavoro dell'area di lavoro pubblicata. :type workspace: azureml.core.Workspace :p aram continue_on_step_failure: Indica se continuare l'esecuzione di altri passaggi in PipelineRun
se un passaggio ha esito negativo, il valore predefinito è false.
- Ereditarietà
-
azureml.core._portal.HasPipelinePortalPublishedPipeline
Costruttore
PublishedPipeline(name, graph_id, description, version, published_pipeline_id, status, endpoint, total_run_steps, workspace, continue_on_step_failure=None, _pipeline_provider=None, **kwargs)
Parametri
Nome | Descrizione |
---|---|
name
Necessario
|
Nome della pipeline pubblicata. |
graph_id
Necessario
|
ID del grafico per questa pipeline pubblicata. |
description
Necessario
|
Descrizione della pipeline pubblicata. |
version
Necessario
|
Versione della pipeline pubblicata. |
published_pipeline_id
Necessario
|
ID della pipeline pubblicata. |
status
Necessario
|
Stato della pipeline pubblicata ('Active' o 'Disabled'). |
endpoint
Necessario
|
URL dell'endpoint REST da inviare per questa pipeline. |
total_run_steps
Necessario
|
Numero di passaggi in questa pipeline. |
workspace
Necessario
|
Area di lavoro della pipeline pubblicata. |
continue_on_step_failure
Necessario
|
Indica se continuare l'esecuzione di altri passaggi in PipelineRun se un passaggio ha esito negativo. Il valore predefinito è false. |
_pipeline_provider
Necessario
|
<xref:azureml.pipeline.core._workflow_provider._PublishedPipelineProvider>
Provider di pipeline pubblicato. |
kwargs
Necessario
|
Argomenti di parole chiave personalizzati, riservati per lo sviluppo futuro |
name
Necessario
|
Nome della pipeline pubblicata. |
graph_id
Necessario
|
ID del grafico per questa pipeline pubblicata. |
description
Necessario
|
Descrizione della pipeline pubblicata. |
version
Necessario
|
Versione della pipeline pubblicata. |
published_pipeline_id
Necessario
|
ID della pipeline pubblicata. |
status
Necessario
|
Stato della pipeline pubblicata ('Active' o 'Disabled'). |
_pipeline_provider
Necessario
|
<xref:azureml.pipeline.core._workflow_provider._PublishedPipelineProvider>
Provider di pipeline pubblicato. |
kwargs
Necessario
|
Argomenti di parole chiave personalizzati, riservati per lo sviluppo futuro |
Commenti
È possibile creare un oggetto PublishedPipeline da un Pipeline oggetto o da un PipelineRunoggetto .
Un esempio di pubblicazione da una pipeline è il seguente:
from azureml.pipeline.core import Pipeline
pipeline = Pipeline(workspace=ws, steps=steps)
published_pipeline = pipeline.publish(name="My_New_Pipeline",
description="My New Pipeline Description",
version="1.0",
continue_on_step_failure=True)
Per pubblicare da un oggetto PipelineRun usare:
from azureml.pipeline.core import PipelineRun
pipeline_run = PipelineRun(experiment=Experiment(ws, "Pipeline_experiment"), run_id="run_id")
published_pipeline = pipeline_run.publish_pipeline(name="My_New_Pipeline",
description="My New Pipeline Description",
version="1.0",
continue_on_step_failure=True)
Nota: il parametro continue_on_step_failure specifica se l'esecuzione di passaggi nella pipeline continuerà se un passaggio ha esito negativo. Il valore predefinito è False, ovvero quando un passaggio ha esito negativo, l'esecuzione della pipeline si interrompe, annullando eventuali passaggi in esecuzione.
Inviare un oggetto PublishedPipeline usando submit. Quando viene chiamato l'invio, viene creato un oggetto PipelineRun che a sua volta crea StepRun oggetti per ogni passaggio del flusso di lavoro.
Un esempio per inviare un file PublishedPipeline è il seguente:
from azureml.pipeline.core import PublishedPipeline
published_pipeline = PublishedPipeline.get(workspace=ws, id="published_pipeline_id")
pipeline_run = experiment.submit(published_pipeline)
Esistono diverse impostazioni facoltative che possono essere specificate durante l'invio di un oggetto PublishedPipeline. Queste includono:
continue_on_step_failure: indica se continuare l'esecuzione di altri passaggi in PipelineRun se un passaggio ha esito negativo, facoltativo. Solo i passaggi che non hanno alcuna dipendenza dall'output del passaggio non riuscito continueranno l'esecuzione. Se specificato, questa impostazione di parametro esegue l'override dell'impostazione nella pipeline.
pipeline_parameters: parametri per l'esecuzione della pipeline, dizionario di {name: value}. Per informazioni dettagliate, vedere PipelineParameter.
parent_run_id: è possibile specificare un ID di esecuzione per impostare l'esecuzione padre di questa pipeline, che si riflette in RunHistory. L'esecuzione padre deve appartenere allo stesso esperimento della pipeline inviata.
Un esempio per inviare un file PublishedPipeline usando queste impostazioni è il seguente:
from azureml.pipeline.core import PublishedPipeline
published_pipeline = PublishedPipeline.get(workspace=ws, id="published_pipeline_id")
pipeline_run = experiment.submit(published_pipeline,
continue_on_step_failure=True,
pipeline_parameters={"param1": "value1"},
parent_run_id="<run_id>")
Tutte le pipeline pubblicate hanno un endpoint REST Con l'endpoint della pipeline è possibile attivare un'esecuzione della pipeline da sistemi esterni, ad esempio client non Python. Per informazioni su come eseguire l'autenticazione quando si chiamano endpoint REST, vedere https://aka.ms/pl-restep-auth.
L'uso dell'endpoint consente la "ripetibilità gestita" negli scenari di assegnazione dei punteggi batch e di ripetizione del training, ad esempio. Per altre informazioni, vedere https://aka.ms/pl-first-pipeline.
Metodi
disable |
Impostare la pipeline pubblicata su "Disabled" e non disponibile per l'esecuzione. |
enable |
Impostare la pipeline pubblicata su "Active" e disponibile per l'esecuzione. |
get |
Ottenere la pipeline pubblicata. |
get_all |
Ottenere tutte le pipeline pubblicate nell'area di lavoro corrente. DEPRECATO: questo metodo è deprecato a favore del metodo PublishedPipeline list . |
get_graph |
Ottenere il grafico di PublishedPipeline. |
get_step_names |
Ottenere l'elenco dei nomi dei passaggi in PublishedPipeline. |
list |
Ottenere tutte le pipeline pubblicate nell'area di lavoro corrente. |
save |
Salvare il file YAML della pipeline in un file. Attualmente, per l'esportazione YAML sono supportate solo le pipeline costituite da ModuleSteps. |
submit |
Inviare la pipeline pubblicata. Equivale all'uso di submit. Restituisce l'oggetto inviato PipelineRun. Usare questo oggetto per monitorare e visualizzare i dettagli dell'esecuzione. |
disable
Impostare la pipeline pubblicata su "Disabled" e non disponibile per l'esecuzione.
disable()
enable
Impostare la pipeline pubblicata su "Active" e disponibile per l'esecuzione.
enable()
get
Ottenere la pipeline pubblicata.
static get(workspace, id, _workflow_provider=None, _service_endpoint=None)
Parametri
Nome | Descrizione |
---|---|
workspace
Necessario
|
L'area di lavoro in cui è stata creata la pipeline pubblicata. |
id
Necessario
|
ID della pipeline pubblicata. |
_workflow_provider
|
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
Provider del flusso di lavoro. Valore predefinito: None
|
_service_endpoint
|
Endpoint del servizio. Valore predefinito: None
|
Restituisce
Tipo | Descrizione |
---|---|
Oggetto PublishedPipeline. |
get_all
Ottenere tutte le pipeline pubblicate nell'area di lavoro corrente.
DEPRECATO: questo metodo è deprecato a favore del metodo PublishedPipeline list .
static get_all(workspace, active_only=True, _service_endpoint=None)
Parametri
Nome | Descrizione |
---|---|
workspace
Necessario
|
L'area di lavoro in cui è stata creata la pipeline pubblicata. |
active_only
|
Indica se restituire solo le pipeline pubblicate attualmente attive. Valore predefinito: True
|
_service_endpoint
|
Endpoint del servizio. Valore predefinito: None
|
Restituisce
Tipo | Descrizione |
---|---|
Elenco di oggetti PublishedPipeline. |
get_graph
Ottenere il grafico di PublishedPipeline.
get_graph(_workflow_provider=None)
Parametri
Nome | Descrizione |
---|---|
_workflow_provider
|
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
Provider del flusso di lavoro. Valore predefinito: None
|
Restituisce
Tipo | Descrizione |
---|---|
Grafico. |
get_step_names
Ottenere l'elenco dei nomi dei passaggi in PublishedPipeline.
get_step_names(_workflow_provider=None)
Parametri
Nome | Descrizione |
---|---|
_workflow_provider
|
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
Provider del flusso di lavoro. Valore predefinito: None
|
Restituisce
Tipo | Descrizione |
---|---|
Elenco dei nomi dei passaggi in PublishedPipeline. |
list
Ottenere tutte le pipeline pubblicate nell'area di lavoro corrente.
static list(workspace, active_only=True, _service_endpoint=None)
Parametri
Nome | Descrizione |
---|---|
workspace
Necessario
|
L'area di lavoro in cui è stata creata la pipeline pubblicata. |
active_only
|
Indica se restituire solo le pipeline pubblicate attualmente attive. Valore predefinito: True
|
_service_endpoint
|
Endpoint del servizio. Valore predefinito: None
|
Restituisce
Tipo | Descrizione |
---|---|
Elenco di oggetti PublishedPipeline. |
save
Salvare il file YAML della pipeline in un file.
Attualmente, per l'esportazione YAML sono supportate solo le pipeline costituite da ModuleSteps.
save(path=None, _workflow_provider=None)
Parametri
Nome | Descrizione |
---|---|
path
|
Percorso in cui salvare il file YAML. Se il percorso è una directory, il file YAML della pipeline viene salvato nel percorso/pipeline_name.yml. Se path è None, viene utilizzata la directory corrente. Valore predefinito: None
|
_workflow_provider
|
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
Provider del flusso di lavoro. Valore predefinito: None
|
Restituisce
Tipo | Descrizione |
---|---|
submit
Inviare la pipeline pubblicata. Equivale all'uso di submit.
Restituisce l'oggetto inviato PipelineRun. Usare questo oggetto per monitorare e visualizzare i dettagli dell'esecuzione.
submit(workspace, experiment_name, pipeline_parameters=None, _workflow_provider=None, _service_endpoint=None, parent_run_id=None, continue_on_step_failure=None)
Parametri
Nome | Descrizione |
---|---|
workspace
Necessario
|
Area di lavoro in cui inviare la pipeline pubblicata. |
experiment_name
Necessario
|
Nome dell'esperimento a cui inviare. |
pipeline_parameters
|
Dizionario di parametri per assegnare nuovi valori {nome param, valore param}. Per informazioni dettagliate, vedere PipelineParameter. Valore predefinito: None
|
_workflow_provider
|
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
Provider del flusso di lavoro. Valore predefinito: None
|
_service_endpoint
|
Endpoint del servizio. Valore predefinito: None
|
parent_run_id
|
ID esecuzione facoltativo da impostare per l'esecuzione padre di questa esecuzione della pipeline, che si riflette in RunHistory. L'esecuzione padre deve appartenere allo stesso esperimento a cui viene inviata la pipeline. Valore predefinito: None
|
continue_on_step_failure
|
Indica se continuare l'esecuzione di altri passaggi in PipelineRun se un passaggio ha esito negativo, facoltativo. Se specificato, eseguirà l'override dell'impostazione nella pipeline. Valore predefinito: None
|
Restituisce
Tipo | Descrizione |
---|---|
Esecuzione della pipeline inviata. |
Attributi
continue_on_step_failure
Ottiene il valore dell'impostazione continue_on_step_failure
.
Restituisce
Tipo | Descrizione |
---|---|
Valore dell'impostazione |
description
Ottenere la descrizione della pipeline pubblicata.
Restituisce
Tipo | Descrizione |
---|---|
Descrizione della pipeline pubblicata. |
endpoint
Ottenere l'URL dell'endpoint REST per l'esecuzione di una pipeline pubblicata.
Restituisce
Tipo | Descrizione |
---|---|
URL dell'endpoint REST per l'esecuzione della pipeline pubblicata. |
graph_id
Ottenere l'ID del grafico per questa pipeline pubblicata.
Restituisce
Tipo | Descrizione |
---|---|
ID del grafico. |
id
Ottenere l'ID della pipeline pubblicata.
Restituisce
Tipo | Descrizione |
---|---|
ID della pipeline pubblicata. |
name
Ottenere il nome della pipeline pubblicata.
Restituisce
Tipo | Descrizione |
---|---|
Nome della pipeline pubblicata. |
status
Ottenere lo stato della pipeline pubblicata.
Restituisce
Tipo | Descrizione |
---|---|
Stato della pipeline pubblicata. |
total_run_steps
Ottenere il numero di passaggi nella pipeline.
Restituisce
Tipo | Descrizione |
---|---|
Numero di passaggi nella pipeline. |
version
Ottenere la versione della pipeline pubblicata.
Restituisce
Tipo | Descrizione |
---|---|
Versione della pipeline pubblicata. |