Compartilhar via


PipelineDraft Classe

Representa um pipeline mutável que pode ser usado para enviar execuções e criar Pipelines Publicados.

Use PipelineDrafts para iterar em Pipelines. PipelineDrafts podem ser criados do zero, outro PipelineDraft ou pipelines existentes: Pipeline, PublishedPipelineou PipelineRun.

Inicializar PipelineDraft.

Construtor

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

Nome Description
workspace
Obrigatório

O objeto de workspace para este PipelineDraft.

id
Obrigatório
str

A ID do PipelineDraft.

name
Obrigatório
str

O nome do PipelineDraft.

description
Obrigatório
str

A descrição do PipelineDraft.

experiment_name
Obrigatório
str

O nome do experimento para o PipelineDraft.

tags
Obrigatório

Um dicionário de marcas opcionais para o PipelineDraft.

properties
Obrigatório

Um dicionário de propriedades opcionais para o PipelineDraft.

graph_draft_id
Obrigatório
str

A ID do rascunho do grafo associado ao PipelineDraft.

parent_pipeline_id
Obrigatório
str

A ID do PublishedPipeline pai.

parent_pipeline_run_id
Obrigatório
str

A ID do PipelineRun pai.

parent_step_run_ids
Obrigatório

Uma lista das IDs steprun do PipelineRun pai.

parent_pipeline_draft_id
Obrigatório
str

A ID do PipelineDraft pai.

last_submitted_pipeline_run_id
Obrigatório
str

A ID do pipelineRun enviado pela última vez.

_pipeline_draft_provider
Obrigatório
<xref:azureml.pipeline.core._aeva_provider._AevaPipelineDraftProvider>

(Somente uso interno.) O provedor PipelineDraft.

workspace
Obrigatório

Objeto de workspace para este PipelineDraft.

id
Obrigatório
str

A ID do PipelineDraft.

name
Obrigatório
str

O nome do PipelineDraft.

description
Obrigatório
str

A descrição do PipelineDraft.

experiment_name
Obrigatório
str

O nome do experimento para o PipelineDraft.

tags
Obrigatório

Dicionário de marcas para o PipelineDraft.

properties
Obrigatório

Dicionário de propriedades para o PipelineDraft.

graph_draft_id
Obrigatório
str

A ID do rascunho do grafo associado ao PipelineDraft.

parent_pipeline_id
Obrigatório
str

A ID do PublishedPipeline pai.

parent_pipeline_run_id
Obrigatório
str

A ID do PipelineRun pai.

parent_step_run_ids
Obrigatório

Uma lista das IDs StepRun do PipelineRun pai.

parent_pipeline_draft_id
Obrigatório
str

A ID do PipelineDraft pai.

last_submitted_pipeline_run_id
Obrigatório
str

A ID do pipelineRun enviado pela última vez.

_pipeline_draft_provider
Obrigatório
<xref:azureml.pipeline.core._aeva_provider._AevaPipelineDraftProvider>

O provedor PipelineDraft.

Comentários

Um PipelineDraft pode ser criado a partir de um Pipeline usando a create função. Um exemplo está abaixo:


   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'})

O parâmetro de pipeline de PipelineDraft.create()também pode ser um PublishedPipeline, PipelineRunou outro PipelineDraft.

Para enviar uma execução de um PipelineDraft, use o submit_run método:


   pipeline_run = pipeline_draft.submit_run()

Para atualizar um PipelineDraft, use o update método. A função update() de um rascunho de pipeline pode ser usada para atualizar o nome, a descrição, o nome do experimento, as atribuições de parâmetro de pipeline, a configuração de falha na etapa e o Pipeline associado ao 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

Crie um PipelineDraft.

delete

Exclua o PipelineDraft.

get

Obtenha o PipelineDraft com a ID fornecida.

get_graph

Obtenha o grafo associado ao PipelineDraft.

list

Obtenha todos os rascunhos de pipeline em um workspace.

publish

Publique um PublishedPipeline do PipelineDraft.

save

Salve o YAML do PipelineDraft em um arquivo.

submit_run

Envie um PipelineRun do PipelineDraft.

update

Atualize um PipelineDraft.

Os campos fornecidos serão atualizados.

create

Crie um 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

Nome Description
workspace
Obrigatório

O objeto de workspace ao qual o PipelineDraft pertencerá.

pipeline
Obrigatório

O pipeline ou pipeline publicado.

name
str

O nome do PipelineDraft; somente necessário ao criar a partir de um Pipeline.

Valor padrão: None
description
str

A descrição do PipelineDraft; somente necessário ao criar a partir de um Pipeline.

Valor padrão: None
experiment_name
str

O nome do experimento para o PipelineDraft; somente necessário ao criar a partir de um Pipeline.

Valor padrão: None
pipeline_parameters

Um dicionário opcional de atribuições de parâmetro de pipeline para o PipelineDraft; somente necessário ao criar a partir de um Pipeline.

Valor padrão: None
continue_on_step_failure

Indica se um PipelineRun será continuado quando uma execução de etapa falhar na configuração do PipelineDraft; somente necessário ao criar a partir de um Pipeline.

Valor padrão: None
tags

Um dicionário de marcas opcionais para o PipelineDraft, necessário somente ao criar a partir de um Pipeline.

Valor padrão: None
properties

Dicionário de propriedades opcionais para o PipelineDraft, necessário somente ao criar a partir de um Pipeline.

Valor padrão: None
_service_endpoint
str

O ponto de extremidade de serviço.

Valor padrão: None
_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>

(Somente uso interno.) O provedor de fluxo de trabalho.

Valor padrão: None

Retornos

Tipo Description

O PipelineDraft criado.

delete

Exclua o PipelineDraft.

delete(_workflow_provider=None)

Parâmetros

Nome Description
_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>

(Somente uso interno.) O provedor de fluxo de trabalho.

Valor padrão: None

get

Obtenha o PipelineDraft com a ID fornecida.

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

Parâmetros

Nome Description
workspace
Obrigatório

O workspace no qual o PipelineDraft foi criado.

id
Obrigatório
str

A ID do PipelineDraft.

_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>

(Somente uso interno.) O provedor de fluxo de trabalho.

Valor padrão: None
_service_endpoint
str

O ponto de extremidade de serviço.

Valor padrão: None

Retornos

Tipo Description

Objeto PipelineDraft

get_graph

Obtenha o grafo associado ao PipelineDraft.

get_graph(_workflow_provider=None)

Parâmetros

Nome Description
_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>

(Somente uso interno.) O provedor de fluxo de trabalho.

Valor padrão: None

Retornos

Tipo Description

O objeto Graph.

list

Obtenha todos os rascunhos de pipeline em um workspace.

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

Parâmetros

Nome Description
workspace
Obrigatório

O workspace do qual listar rascunhos.

tags

Se especificado, retorna rascunhos correspondentes a {"tag": "value"}.

Valor padrão: None
_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>

(Somente uso interno.) O provedor de fluxo de trabalho.

Valor padrão: None

Retornos

Tipo Description

Uma lista de PipelineDraft objetos.

publish

Publique um PublishedPipeline do PipelineDraft.

publish(_workflow_provider=None)

Parâmetros

Nome Description
_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>

(Somente uso interno.) O provedor de fluxo de trabalho.

Valor padrão: None

Retornos

Tipo Description

O PublishedPipeline criado.

save

Salve o YAML do PipelineDraft em um arquivo.

save(path=None, _workflow_provider=None)

Parâmetros

Nome Description
path
str

O caminho para o qual salvar o YAML. Se o caminho for um diretório, o arquivo YAML do PipelineDraft será salvo no caminho/pipeline_name.yml. Se o caminho for Nenhum, o diretório atual será usado.

Valor padrão: None
_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>

(Somente uso interno.) O provedor de fluxo de trabalho.

Valor padrão: None

Retornos

Tipo Description

submit_run

Envie um PipelineRun do PipelineDraft.

submit_run(_workflow_provider=None)

Parâmetros

Nome Description
_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>

(Somente uso interno.) O provedor de fluxo de trabalho.

Valor padrão: None

Retornos

Tipo Description

O PipelineRun enviado.

update

Atualize um PipelineDraft.

Os campos fornecidos serão atualizados.

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

Nome Description
pipeline

O pipeline atualizado para o rascunho.

Valor padrão: None
name
str

O nome do PipelineDraft.

Valor padrão: None
description
str

A descrição do PipelineDraft.

Valor padrão: None
experiment_name
str

O nome do experimento para o PipelineDraft.

Valor padrão: None
tags

Um dicionário de marcas para o PipelineDraft.

Valor padrão: None
pipeline_parameters

As atribuições de parâmetro de pipeline para o PipelineDraft.

Valor padrão: None
continue_on_step_failure

Se deve continuar PipelineRun quando uma execução de etapa falhar na configuração do PipelineDraft.

Valor padrão: None
_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>

(Somente uso interno.) O provedor de fluxo de trabalho.

Valor padrão: None

Atributos

description

Obtenha a descrição do PipelineDraft.

Retornos

Tipo Description
str

A cadeia de caracteres de descrição.

id

Obtenha a ID do PipelineDraft.

Retornos

Tipo Description
str

A ID.

last_submitted_pipeline_run_id

Obtenha a ID do último PipelineRun enviado do PipelineDraft.

Retornos

Tipo Description
str

A ID do PipelineRun.

name

Tet o nome do PipelineDraft.

Retornos

Tipo Description
str

O nome.

parent_pipeline_draft_id

Obtenha a ID do PipelineDraft pai do PipelineDraft.

Retornos

Tipo Description
str

A ID do PipelineDraft.

parent_pipeline_id

Obtenha a ID do PublishedPipeline pai do PipelineDraft.

Retornos

Tipo Description
str

A ID do PublishedPipeline.

parent_pipeline_run_id

Obtenha a ID do PipelineRun pai do PipelineDraft.

Retornos

Tipo Description
str

A ID do PipelineRun.

parent_step_run_ids

Obtenha a lista de IDs StepRun do PipelineRun pai do PipelineDraft.

Retornos

Tipo Description

Uma lista de IDs steprun.

properties

Obtenha as propriedades do PipelineDraft.

Retornos

Tipo Description

O dicionário de propriedades.

tags

Obtenha as marcas do PipelineDraft.

Retornos

Tipo Description

O dicionário de marcas.