PipelineDraft Clase

Referencia

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

Nombre	Description
workspace Requerido	Workspace Objeto de área de trabajo para esta instancia de PipelineDraft.
id Requerido	str Id. de PipelineDraft.
name Requerido	str Nombre de PipelineDraft.
description Requerido	str Descripción de PipelineDraft.
experiment_name Requerido	str Nombre de experimento para PipelineDraft.
tags Requerido	Dict[str, str] Diccionario de etiquetas opcionales para PipelineDraft.
properties Requerido	Dict[str, str] Diccionario de propiedades opcionales para PipelineDraft.
graph_draft_id Requerido	str Id. del borrador del grafo asociado a PipelineDraft.
parent_pipeline_id Requerido	str Id. del elemento PublishedPipeline primario.
parent_pipeline_run_id Requerido	str Id. del elemento PipelineRun primario.
parent_step_run_ids Requerido	list Lista de los id. de StepRun del elemento PipelineRun primario.
parent_pipeline_draft_id Requerido	str Id. del elemento PipelineDraft primario.
last_submitted_pipeline_run_id Requerido	str Id. del último elemento PipelineRun enviado.
_pipeline_draft_provider Requerido	<xref:azureml.pipeline.core._aeva_provider._AevaPipelineDraftProvider> (Solo uso interno). Proveedor PipelineDraft.
workspace Requerido	Workspace Objeto Workspace para este PipelineDraft.
id Requerido	str Identificador de PipelineDraft.
name Requerido	str Nombre de PipelineDraft.
description Requerido	str Descripción de PipelineDraft.
experiment_name Requerido	str Nombre de experimento para PipelineDraft.
tags Requerido	Dict[str, str] Diccionario de etiquetas para PipelineDraft.
properties Requerido	Dict[str, str] Diccionario de propiedades para PipelineDraft.
graph_draft_id Requerido	str Identificador del borrador del grafo asociado a PipelineDraft.
parent_pipeline_id Requerido	str Identificador del elemento primario PublishedPipeline.
parent_pipeline_run_id Requerido	str Identificador del pipelineRun primario.
parent_step_run_ids Requerido	list Una lista de los identificadores StepRun del pipelineRun primario.
parent_pipeline_draft_id Requerido	str Identificador del pipelineDraft primario.
last_submitted_pipeline_run_id Requerido	str Identificador del último pipelineRun enviado.
_pipeline_draft_provider Requerido	<xref:azureml.pipeline.core._aeva_provider._AevaPipelineDraftProvider> 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

Nombre	Description
workspace Requerido	Workspace Objeto de área de trabajo al que pertenece esta instancia de PipelineDraft.
pipeline Requerido	PublishedPipeline o Pipeline o PipelineRun o PipelineDraft Canalización publicada o canalización.
name	str Nombre de PipelineDraft; solo es necesario al crear a partir de una Pipeline. valor predeterminado: None
description	str Descripción de PipelineDraft; solo es necesaria al crear a partir de una Pipeline. valor predeterminado: None
experiment_name	str Nombre del experimento para PipelineDraft; solo es necesario al crear a partir de una Pipeline. valor predeterminado: None
pipeline_parameters	Dict[str, str] Diccionario de asignaciones opcionales de parámetros de canalización para PipelineDraft; solo es necesario al crear a partir de una Pipeline. valor predeterminado: None
continue_on_step_failure	bool 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. valor predeterminado: None
tags	Dict[str, str] Diccionario de etiquetas opcionales para PipelineDraft, solo necesario al crear a partir de una Pipeline. valor predeterminado: None
properties	Dict[str, str] Diccionario de propiedades opcionales para PipelineDraft, solo necesario al crear a partir de una Pipeline. valor predeterminado: None
_service_endpoint	str Extremo del servicio. valor predeterminado: None
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> (Solo uso interno). Proveedor de flujo de trabajo. valor predeterminado: None

Devoluciones

Tipo	Description
PipelineDraft	PipelineDraft creado.

delete

Elimina el elemento PipelineDraft.

delete(_workflow_provider=None)

Parámetros

Nombre	Description
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> (Solo uso interno). Proveedor de flujo de trabajo. valor predeterminado: None

get

Obtiene el elemento PipelineDraft con el id. especificado.

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

Parámetros

Nombre	Description
workspace Requerido	Workspace Área de trabajo en la que se creó PipelineDraft.
id Requerido	str Id. de PipelineDraft.
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> (Solo uso interno). Proveedor de flujo de trabajo. valor predeterminado: None
_service_endpoint	str Extremo del servicio. valor predeterminado: None

Devoluciones

Tipo	Description
PipelineDraft	Objeto PipelineDraft

get_graph

Obtiene el grafo asociado a PipelineDraft.

get_graph(_workflow_provider=None)

Parámetros

Nombre	Description
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> (Solo uso interno). Proveedor de flujo de trabajo. valor predeterminado: None

Devoluciones

Tipo	Description
Graph	Objeto de grafo.

list

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

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

Parámetros

Nombre	Description
workspace Requerido	Workspace Área de trabajo de la cual se van a enumerar los entornos.
tags	dict Si se especifica, devuelve las ejecuciones que coinciden con el elemento especificado {"tag": "value"}. valor predeterminado: None
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> (Solo uso interno). Proveedor de flujo de trabajo. valor predeterminado: None

Devoluciones

Tipo	Description
list	Una lista de objetos PipelineDraft.

publish

Publica un elemento PublishedPipeline desde PipelineDraft.

publish(_workflow_provider=None)

Parámetros

Nombre	Description
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> (Solo uso interno). Proveedor de flujo de trabajo. valor predeterminado: None

Devoluciones

Tipo	Description
PublishedPipeline	PublishedPipeline creado.

save

Guarde el archivo YAML de PipelineDraft en un archivo.

save(path=None, _workflow_provider=None)

Parámetros

Nombre	Description
path	str 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. valor predeterminado: None
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> (Solo uso interno). Proveedor de flujo de trabajo. valor predeterminado: None

Devoluciones

Tipo	Description
None

submit_run

Envía un elemento PipelineRun desde PipelineDraft.

submit_run(_workflow_provider=None)

Parámetros

Nombre	Description
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> (Solo uso interno). Proveedor de flujo de trabajo. valor predeterminado: None

Devoluciones

Tipo	Description
PipelineRun	PipelineRun enviado.

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

Nombre	Description
pipeline	Pipeline Canalización actualizada para el borrador. valor predeterminado: None
name	str Nombre de PipelineDraft. valor predeterminado: None
description	str Descripción de PipelineDraft. valor predeterminado: None
experiment_name	str Nombre de experimento para PipelineDraft. valor predeterminado: None
tags	Dict[str, str] Diccionario de etiquetas para PipelineDraft. valor predeterminado: None
pipeline_parameters	Dict[str, str] Asignaciones de parámetros de canalización para PipelineDraft. valor predeterminado: None
continue_on_step_failure	bool Si se debe continuar PipelineRun cuando se produce un error en la ejecución de un paso en la configuración de PipelineDraft. valor predeterminado: None
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> (Solo uso interno). Proveedor de flujo de trabajo. valor predeterminado: None

Atributos

description

Obtiene la descripción de PipelineDraft.

Devoluciones

Tipo	Description
str	Cadena de descripción.

id

Obtiene el id. de PipelineDraft.

Devoluciones

Tipo	Description
str	El identificador.

last_submitted_pipeline_run_id

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

Devoluciones

Tipo	Description
str	Id. de PipelineRun.

name

Nombre de PipelineDraft.

Devoluciones

Tipo	Description
str	Nombre.

parent_pipeline_draft_id

Obtiene el id. del elemento PipelineDraft primario de PipelineDraft.

Devoluciones

Tipo	Description
str	Id. de PipelineDraft.

parent_pipeline_id

Obtiene el id. del elemento PublishedPipeline primario de PipelineDraft.

Devoluciones

Tipo	Description
str	Id. de PublishedPipeline.

parent_pipeline_run_id

Obtiene el id. del elemento PipelineRun primario de PipelineDraft.

Devoluciones

Tipo	Description
str	Id. de PipelineRun.

parent_step_run_ids

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

Devoluciones

Tipo	Description
list	Lista de los id. de StepRun.

properties

Obtiene las propiedades de PipelineDraft.

Devoluciones

Tipo	Description
dict	Propiedades del diccionario.

Compartir a través de

PipelineDraft Clase

Constructor

Parámetros

Comentarios

Métodos

create

Parámetros

Devoluciones

delete

Parámetros

get

Parámetros

Devoluciones

get_graph

Parámetros

Devoluciones

list

Parámetros

Devoluciones

publish

Parámetros

Devoluciones

save

Parámetros

Devoluciones

submit_run

Parámetros

Devoluciones

update

Parámetros

Atributos

description

Devoluciones

id

Devoluciones

last_submitted_pipeline_run_id

Devoluciones

name

Devoluciones

parent_pipeline_draft_id

Devoluciones

parent_pipeline_id

Devoluciones

parent_pipeline_run_id

Devoluciones

parent_step_run_ids

Devoluciones

properties

Devoluciones

tags

Devoluciones

Comentarios

Comentarios

Recursos adicionales