Compartir a través de


PipelineDraft Clase

Representa una canalización mutable que se puede usar para enviar ejecuciones y crear canalizaciones publicadas.

Use PipelineDrafts para iterar en canalizaciones. Los elementos PipelineDrafts se pueden crear desde cero, otro PipelineDraft o canalizaciones existentes: Pipeline, PublishedPipeline o PipelineRun.

Inicializar PipelineDraft.

Herencia
builtins.object
PipelineDraft

Constructor

PipelineDraft(workspace, id, name=None, description=None, experiment_name=None, tags=None, properties=None, graph_draft_id=None, parent_pipeline_id=None, parent_pipeline_run_id=None, parent_step_run_ids=None, parent_pipeline_draft_id=None, last_submitted_pipeline_run_id=None, _pipeline_draft_provider=None)

Parámetros

workspace
Workspace
Requerido

Objeto de área de trabajo para esta instancia de PipelineDraft.

id
str
Requerido

Id. de PipelineDraft.

name
str
Requerido

Nombre de PipelineDraft.

description
str
Requerido

Descripción de PipelineDraft.

experiment_name
str
Requerido

Nombre de experimento para PipelineDraft.

tags
Dict[str, str]
Requerido

Diccionario de etiquetas opcionales para PipelineDraft.

properties
Dict[str, str]
Requerido

Diccionario de propiedades opcionales para PipelineDraft.

graph_draft_id
str
Requerido

Id. del borrador del grafo asociado a PipelineDraft.

parent_pipeline_id
str
Requerido

Id. del elemento PublishedPipeline primario.

parent_pipeline_run_id
str
Requerido

Id. del elemento PipelineRun primario.

parent_step_run_ids
list
Requerido

Lista de los id. de StepRun del elemento PipelineRun primario.

parent_pipeline_draft_id
str
Requerido

Id. del elemento PipelineDraft primario.

last_submitted_pipeline_run_id
str
Requerido

Id. del último elemento PipelineRun enviado.

_pipeline_draft_provider
<xref:azureml.pipeline.core._aeva_provider._AevaPipelineDraftProvider>
Requerido

(Solo uso interno). Proveedor PipelineDraft.

workspace
Workspace
Requerido

Objeto Workspace para este PipelineDraft.

id
str
Requerido

Identificador de PipelineDraft.

name
str
Requerido

Nombre de PipelineDraft.

description
str
Requerido

Descripción de PipelineDraft.

experiment_name
str
Requerido

Nombre de experimento para PipelineDraft.

tags
Dict[str, str]
Requerido

Diccionario de etiquetas para PipelineDraft.

properties
Dict[str, str]
Requerido

Diccionario de propiedades para PipelineDraft.

graph_draft_id
str
Requerido

Identificador del borrador del grafo asociado a PipelineDraft.

parent_pipeline_id
str
Requerido

Identificador del elemento primario PublishedPipeline.

parent_pipeline_run_id
str
Requerido

Identificador del pipelineRun primario.

parent_step_run_ids
list
Requerido

Una lista de los identificadores StepRun del pipelineRun primario.

parent_pipeline_draft_id
str
Requerido

Identificador del pipelineDraft primario.

last_submitted_pipeline_run_id
str
Requerido

Identificador del último pipelineRun enviado.

_pipeline_draft_provider
<xref:azureml.pipeline.core._aeva_provider._AevaPipelineDraftProvider>
Requerido

Proveedor de PipelineDraft.

Comentarios

Un elemento PipelineDraft se puede crear a partir de una Pipeline mediante la función create. A continuación se muestra un ejemplo:


   from azureml.pipeline.core import Pipeline, PipelineDraft
   from azureml.pipeline.steps import PythonScriptStep

   train_step = PythonScriptStep(name="Training_Step",
                                 script_name="train.py",
                                 compute_target=aml_compute_target,
                                 source_directory=".")
   pipeline = Pipeline(workspace=ws, steps=[train_step])
   pipeline_draft = PipelineDraft.create(workspace=ws,
                                         name="TestPipelineDraft",
                                         description="draft description",
                                         experiment_name="helloworld",
                                         pipeline=pipeline,
                                         continue_on_step_failure=True,
                                         tags={'dev': 'true'},
                                         properties={'train': 'value'})

Parámetro de canalización de PipelineDraft.create() también puede ser PublishedPipeline, PipelineRun u otro PipelineDraft.

Para enviar una ejecución desde PipelineDraft, use el método submit_run:


   pipeline_run = pipeline_draft.submit_run()

Para actualizar un elemento PipelineDraft, use el método update. La función update() de un borrador de canalización se puede usar para actualizar el nombre, la descripción, el nombre del experimento, las asignaciones de parámetros de canalización, continuar en la configuración de error de paso y la canalización asociada a PipelineDraft.


   new_train_step = PythonScriptStep(name="New_Training_Step",
                                     script_name="train.py",
                                     compute_target=aml_compute_target,
                                     source_directory=source_directory)

   new_pipeline = Pipeline(workspace=ws, steps=[new_train_step])

   pipeline_draft.update(name="UpdatedPipelineDraft",
                         description="has updated train step",
                         pipeline=new_pipeline)

Métodos

create

Crea un elemento PipelineDraft.

delete

Elimina el elemento PipelineDraft.

get

Obtiene el elemento PipelineDraft con el id. especificado.

get_graph

Obtiene el grafo asociado a PipelineDraft.

list

Obtiene todos los borradores de canalización en un área de trabajo.

publish

Publica un elemento PublishedPipeline desde PipelineDraft.

save

Guarde el archivo YAML de PipelineDraft en un archivo.

submit_run

Envía un elemento PipelineRun desde PipelineDraft.

update

Actualiza un elemento PipelineDraft.

Se actualizarán los campos proporcionados.

create

Crea un elemento PipelineDraft.

static create(workspace, pipeline, name=None, description=None, experiment_name=None, pipeline_parameters=None, continue_on_step_failure=None, tags=None, properties=None, _workflow_provider=None, _service_endpoint=None)

Parámetros

workspace
Workspace
Requerido

Objeto de área de trabajo al que pertenece esta instancia de PipelineDraft.

pipeline
PublishedPipeline o Pipeline o PipelineRun o PipelineDraft
Requerido

Canalización publicada o canalización.

name
str
valor predeterminado: None

Nombre de PipelineDraft; solo es necesario al crear a partir de una Pipeline.

description
str
valor predeterminado: None

Descripción de PipelineDraft; solo es necesaria al crear a partir de una Pipeline.

experiment_name
str
valor predeterminado: None

Nombre del experimento para PipelineDraft; solo es necesario al crear a partir de una Pipeline.

pipeline_parameters
Dict[str, str]
valor predeterminado: None

Diccionario de asignaciones opcionales de parámetros de canalización para PipelineDraft; solo es necesario al crear a partir de una Pipeline.

continue_on_step_failure
bool
valor predeterminado: None

Indica si se debe continuar con PipelineRun cuando se produce un error en la ejecución de un paso de la configuración de PipelineDraft; solo es necesario al crear a partir de una Pipeline.

tags
Dict[str, str]
valor predeterminado: None

Diccionario de etiquetas opcionales para PipelineDraft, solo necesario al crear a partir de una Pipeline.

properties
Dict[str, str]
valor predeterminado: None

Diccionario de propiedades opcionales para PipelineDraft, solo necesario al crear a partir de una Pipeline.

_service_endpoint
str
valor predeterminado: None

Extremo del servicio.

_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
valor predeterminado: None

(Solo uso interno). Proveedor de flujo de trabajo.

Devoluciones

PipelineDraft creado.

Tipo de valor devuelto

delete

Elimina el elemento PipelineDraft.

delete(_workflow_provider=None)

Parámetros

_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
valor predeterminado: None

(Solo uso interno). Proveedor de flujo de trabajo.

get

Obtiene el elemento PipelineDraft con el id. especificado.

static get(workspace, id, _workflow_provider=None, _service_endpoint=None)

Parámetros

workspace
Workspace
Requerido

Área de trabajo en la que se creó PipelineDraft.

id
str
Requerido

Id. de PipelineDraft.

_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
valor predeterminado: None

(Solo uso interno). Proveedor de flujo de trabajo.

_service_endpoint
str
valor predeterminado: None

Extremo del servicio.

Devoluciones

Objeto PipelineDraft

Tipo de valor devuelto

get_graph

Obtiene el grafo asociado a PipelineDraft.

get_graph(_workflow_provider=None)

Parámetros

_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
valor predeterminado: None

(Solo uso interno). Proveedor de flujo de trabajo.

Devoluciones

Objeto de grafo.

Tipo de valor devuelto

list

Obtiene todos los borradores de canalización en un área de trabajo.

static list(workspace, tags=None, _workflow_provider=None)

Parámetros

workspace
Workspace
Requerido

Área de trabajo de la cual se van a enumerar los entornos.

tags
dict
valor predeterminado: None

Si se especifica, devuelve las ejecuciones que coinciden con el elemento especificado {"tag": "value"}.

_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
valor predeterminado: None

(Solo uso interno). Proveedor de flujo de trabajo.

Devoluciones

Una lista de objetos PipelineDraft.

Tipo de valor devuelto

publish

Publica un elemento PublishedPipeline desde PipelineDraft.

publish(_workflow_provider=None)

Parámetros

_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
valor predeterminado: None

(Solo uso interno). Proveedor de flujo de trabajo.

Devoluciones

PublishedPipeline creado.

Tipo de valor devuelto

save

Guarde el archivo YAML de PipelineDraft en un archivo.

save(path=None, _workflow_provider=None)

Parámetros

path
str
valor predeterminado: None

Ruta de acceso en la que se guardará el archivo YAML. Si la ruta de acceso es un directorio, el archivo YAML de PipelineDraft se guarda en path/pipeline_name.yml. Si la ruta de acceso es None, se usará el directorio actual.

_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
valor predeterminado: None

(Solo uso interno). Proveedor de flujo de trabajo.

Tipo de valor devuelto

submit_run

Envía un elemento PipelineRun desde PipelineDraft.

submit_run(_workflow_provider=None)

Parámetros

_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
valor predeterminado: None

(Solo uso interno). Proveedor de flujo de trabajo.

Devoluciones

PipelineRun enviado.

Tipo de valor devuelto

update

Actualiza un elemento PipelineDraft.

Se actualizarán los campos proporcionados.

update(pipeline=None, name=None, description=None, experiment_name=None, tags=None, pipeline_parameters=None, continue_on_step_failure=None, _workflow_provider=None)

Parámetros

pipeline
Pipeline
valor predeterminado: None

Canalización actualizada para el borrador.

name
str
valor predeterminado: None

Nombre de PipelineDraft.

description
str
valor predeterminado: None

Descripción de PipelineDraft.

experiment_name
str
valor predeterminado: None

Nombre de experimento para PipelineDraft.

tags
Dict[str, str]
valor predeterminado: None

Diccionario de etiquetas para PipelineDraft.

pipeline_parameters
Dict[str, str]
valor predeterminado: None

Asignaciones de parámetros de canalización para PipelineDraft.

continue_on_step_failure
bool
valor predeterminado: None

Si se debe continuar PipelineRun cuando se produce un error en la ejecución de un paso en la configuración de PipelineDraft.

_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>
valor predeterminado: None

(Solo uso interno). Proveedor de flujo de trabajo.

Atributos

description

Obtiene la descripción de PipelineDraft.

Devoluciones

Cadena de descripción.

Tipo de valor devuelto

str

id

Obtiene el id. de PipelineDraft.

Devoluciones

El identificador.

Tipo de valor devuelto

str

last_submitted_pipeline_run_id

Obtiene el id. del último elemento PipelineRun enviado de PipelineDraft.

Devoluciones

Id. de PipelineRun.

Tipo de valor devuelto

str

name

Nombre de PipelineDraft.

Devoluciones

Nombre.

Tipo de valor devuelto

str

parent_pipeline_draft_id

Obtiene el id. del elemento PipelineDraft primario de PipelineDraft.

Devoluciones

Id. de PipelineDraft.

Tipo de valor devuelto

str

parent_pipeline_id

Obtiene el id. del elemento PublishedPipeline primario de PipelineDraft.

Devoluciones

Id. de PublishedPipeline.

Tipo de valor devuelto

str

parent_pipeline_run_id

Obtiene el id. del elemento PipelineRun primario de PipelineDraft.

Devoluciones

Id. de PipelineRun.

Tipo de valor devuelto

str

parent_step_run_ids

Obtiene la lista de los id. de StepRun del elemento PipelineRun primario de PipelineDraft.

Devoluciones

Lista de los id. de StepRun.

Tipo de valor devuelto

properties

Obtiene las propiedades de PipelineDraft.

Devoluciones

Propiedades del diccionario.

Tipo de valor devuelto

tags

Obtiene las etiquetas de PipelineDraft.

Devoluciones

Diccionario de etiquetas.

Tipo de valor devuelto