PublishedPipeline Classe

Rappresenta una pipeline da inviare senza il codice Python che lo ha costruito.

Inoltre, è possibile usare una proprietà PublishedPipeline per inviare di nuovo un oggetto Pipeline con valori e input diversi PipelineParameter .

Inizializzare PublishedPipeline.

:p aram endpoint L'URL dell'endpoint REST 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 workspace: l'area di lavoro della pipeline 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.HasPipelinePortal
PublishedPipeline

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

name
str
Necessario

Nome della pipeline pubblicata.

graph_id
str
Necessario

ID del grafico per questa pipeline pubblicata.

description
str
Necessario

Descrizione della pipeline pubblicata.

version
str
Necessario

Versione della pipeline pubblicata.

published_pipeline_id
str
Necessario

ID della pipeline pubblicata.

status
str
Necessario

Stato della pipeline pubblicata ('Active' o 'Disabilitato').

endpoint
str
Necessario

URL dell'endpoint REST da inviare per questa pipeline.

total_run_steps
int
Necessario

Numero di passaggi in questa pipeline.

workspace
Workspace
Necessario

Area di lavoro della pipeline pubblicata.

continue_on_step_failure
bool
Necessario

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

_pipeline_provider
<xref:azureml.pipeline.core._workflow_provider._PublishedPipelineProvider>
Necessario

Provider di pipeline pubblicato.

kwargs
dict
Necessario

Argomenti parole chiave personalizzati, riservati per lo sviluppo futuro

name
str
Necessario

Nome della pipeline pubblicata.

graph_id
str
Necessario

ID del grafico per questa pipeline pubblicata.

description
str
Necessario

Descrizione della pipeline pubblicata.

version
str
Necessario

Versione della pipeline pubblicata.

published_pipeline_id
str
Necessario

ID della pipeline pubblicata.

status
str
Necessario

Stato della pipeline pubblicata ('Attivo' o 'Disabilitato').

_pipeline_provider
<xref:azureml.pipeline.core._workflow_provider._PublishedPipelineProvider>
Necessario

Provider di pipeline pubblicato.

kwargs
dict
Necessario

Argomenti parole chiave personalizzati, riservati per lo sviluppo futuro

Commenti

È possibile creare una proprietà PublishedPipeline da o Pipeline .PipelineRun

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 eseguire la pubblicazione 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 dei 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 verrà arrestata, annullando tutti i passaggi in esecuzione.

Inviare un oggetto PublishedPipeline usando submit. Quando viene chiamato submit, viene creato un PipelineRun oggetto che a sua volta crea StepRun oggetti per ogni passaggio del flusso di lavoro.

Di seguito è riportato un esempio di invio di publishedPipeline:


   from azureml.pipeline.core import PublishedPipeline

   published_pipeline = PublishedPipeline.get(workspace=ws, id="published_pipeline_id")
   pipeline_run = experiment.submit(published_pipeline)

Durante l'invio di un elemento PublishedPipeline è possibile specificare diverse impostazioni facoltative. 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 a essere eseguiti. 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 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 oggetto 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 gli 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 ripetizione del training, ad esempio. Per altre informazioni, vedere https://aka.ms/pl-first-pipeline.

Metodi

disable

Impostare la pipeline pubblicata su "Disabilitata" 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 viene 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 la pipeline YAML in un file.

Attualmente, solo le pipeline costituite da ModuleSteps sono supportate per l'esportazione di YAML.

submit

Inviare la pipeline pubblicata. Equivale all'uso submitdi .

Restituisce l'oggetto inviato PipelineRun. Utilizzare questo oggetto per monitorare e visualizzare i dettagli dell'esecuzione.

disable

Impostare la pipeline pubblicata su "Disabilitata" 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

workspace
Workspace
Necessario

L'area di lavoro in cui è stata creata la pipeline pubblicata.

id
str
Necessario

ID della pipeline pubblicata.

_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
valore predefinito: None

Provider del flusso di lavoro.

_service_endpoint
str
valore predefinito: None

Endpoint del servizio.

Restituisce

Oggetto PublishedPipeline.

Tipo restituito

get_all

Ottenere tutte le pipeline pubblicate nell'area di lavoro corrente.

DEPRECATO: questo metodo viene deprecato a favore del metodo PublishedPipeline list .

static get_all(workspace, active_only=True, _service_endpoint=None)

Parametri

workspace
Workspace
Necessario

L'area di lavoro in cui è stata creata la pipeline pubblicata.

active_only
bool
valore predefinito: True

Se restituire solo pipeline pubblicate attualmente attive.

_service_endpoint
str
valore predefinito: None

Endpoint del servizio.

Restituisce

Elenco di oggetti PublishedPipeline.

Tipo restituito

get_graph

Ottenere il grafico di PublishedPipeline.

get_graph(_workflow_provider=None)

Parametri

_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
valore predefinito: None

Provider del flusso di lavoro.

Restituisce

Grafico.

Tipo restituito

get_step_names

Ottenere l'elenco dei nomi dei passaggi in PublishedPipeline.

get_step_names(_workflow_provider=None)

Parametri

_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
valore predefinito: None

Provider del flusso di lavoro.

Restituisce

Elenco dei nomi dei passaggi in PublishedPipeline.

Tipo restituito

list

Ottenere tutte le pipeline pubblicate nell'area di lavoro corrente.

static list(workspace, active_only=True, _service_endpoint=None)

Parametri

workspace
Workspace
Necessario

L'area di lavoro in cui è stata creata la pipeline pubblicata.

active_only
bool
valore predefinito: True

Se restituire solo pipeline pubblicate attualmente attive.

_service_endpoint
str
valore predefinito: None

Endpoint del servizio.

Restituisce

Elenco di oggetti PublishedPipeline.

Tipo restituito

save

Salvare la pipeline YAML in un file.

Attualmente, solo le pipeline costituite da ModuleSteps sono supportate per l'esportazione di YAML.

save(path=None, _workflow_provider=None)

Parametri

path
str
valore predefinito: None

Percorso in cui salvare YAML. Se il percorso è una directory, il file YAML della pipeline viene salvato nel percorso/pipeline_name.yml. Se il percorso è Nessuno, viene usata la directory corrente.

_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
valore predefinito: None

Provider del flusso di lavoro.

Tipo restituito

submit

Inviare la pipeline pubblicata. Equivale all'uso submitdi .

Restituisce l'oggetto inviato PipelineRun. Utilizzare 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

workspace
Workspace
Necessario

Area di lavoro in cui inviare la pipeline pubblicata.

experiment_name
str
Necessario

Nome dell'esperimento da inviare.

pipeline_parameters
dict
valore predefinito: None

Dizionario dei parametri per assegnare nuovi valori {param name, param value}. Per informazioni dettagliate, vedere PipelineParameter.

_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
valore predefinito: None

Provider del flusso di lavoro.

_service_endpoint
str
valore predefinito: None

Endpoint del servizio.

parent_run_id
str
valore predefinito: None

ID esecuzione facoltativo da impostare per l'esecuzione padre di questa pipeline, che viene riflessa in RunHistory. L'esecuzione padre deve appartenere allo stesso esperimento a cui viene inviata la pipeline.

continue_on_step_failure
bool
valore predefinito: None

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.

Restituisce

Esecuzione della pipeline inviata.

Tipo restituito

Attributi

continue_on_step_failure

Ottenere il valore dell'impostazione continue_on_step_failure .

Restituisce

Valore dell'impostazione continue_on_step_failure .

Tipo restituito

description

Ottenere la descrizione della pipeline pubblicata.

Restituisce

Descrizione della pipeline pubblicata.

Tipo restituito

str

endpoint

Ottenere l'URL dell'endpoint REST per l'esecuzione di una pipeline pubblicata.

Restituisce

URL dell'endpoint REST per l'esecuzione della pipeline pubblicata.

Tipo restituito

str

graph_id

Ottenere l'ID del grafico per questa pipeline pubblicata.

Restituisce

ID del grafico.

Tipo restituito

str

id

Ottenere l'ID della pipeline pubblicata.

Restituisce

ID della pipeline pubblicata.

Tipo restituito

str

name

Ottenere il nome della pipeline pubblicata.

Restituisce

Nome della pipeline pubblicato.

Tipo restituito

str

status

Ottenere lo stato della pipeline pubblicata.

Restituisce

Stato della pipeline pubblicata.

Tipo restituito

str

total_run_steps

Ottenere il numero di passaggi nella pipeline.

Restituisce

Numero di passaggi nella pipeline.

Tipo restituito

int

version

Ottenere la versione della pipeline pubblicata.

Restituisce

Versione della pipeline pubblicata.

Tipo restituito

str