PipelineDraft Classe

Referência

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, de outro PipelineDraft ou de pipelines existentes: Pipeline, PublishedPipeline ou PipelineRun.

Inicializar PipelineDraft.

Herança: builtins.object

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	Workspace O objeto de workspace para esse 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	Dict[str, str] Um dicionário de marcas opcional para o PipelineDraft.
properties Obrigatório	Dict[str, str] Um dicionário de propriedades opcional para o PipelineDraft.
graph_draft_id Obrigatório	str O 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	list Uma lista das IDs de 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 último PipelineRun enviado.
_pipeline_draft_provider Obrigatório	<xref:azureml.pipeline.core._aeva_provider._AevaPipelineDraftProvider> (Somente uso interno.) O provedor PipelineDraft.
workspace Obrigatório	Workspace Objeto 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	Dict[str, str] Dicionário de marcas para o PipelineDraft.
properties Obrigatório	Dict[str, str] 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	list 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 último PipelineRun enviado.
_pipeline_draft_provider Obrigatório	<xref:azureml.pipeline.core._aeva_provider._AevaPipelineDraftProvider> O provedor do PipelineDraft.

Comentários

Um PipelineDraft pode ser criado a partir de um Pipeline usando a função create. Veja um exemplo 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 do PipelineDraft.create() também pode ser um PublishedPipeline, PipelineRun ou outro PipelineDraft.

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


   pipeline_run = pipeline_draft.submit_run()

Para atualizar um PipelineDraft, use o método update. 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âmetros do pipeline, continuar na configuração de falha da 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	Cria um PipelineDraft.
delete	Exclui o PipelineDraft.
get	Obtém o PipelineDraft com a ID fornecida.
get_graph	Obter o gráfico associado ao PipelineDraft.
list	Obtém todos os rascunhos de pipeline em um workspace.
publish	Publica um PublishedPipeline do PipelineDraft.
save	Salve o YAML do PipelineDraft em um arquivo.
submit_run	Envia um PipelineRun do PipelineDraft.
update	Atualiza um PipelineDraft. Os campos fornecidos serão atualizados.

create

Cria 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	Workspace O objeto de workspace ao qual esse PipelineDraft pertencerá.
pipeline Obrigatório	PublishedPipeline ou Pipeline ou PipelineRun ou PipelineDraft O pipeline ou o pipeline publicado.
name	str O nome do PipelineDraft; necessário apenas ao criar a partir de um arquivo Pipeline. Valor padrão: None
description	str A descrição do PipelineDraft; necessário apenas ao criar a partir de um arquivo Pipeline. Valor padrão: None
experiment_name	str O nome do experimento para o PipelineDraft; necessário apenas ao criar a partir de um arquivo Pipeline. Valor padrão: None
pipeline_parameters	Dict[str, str] Um dicionário opcional de atribuições de parâmetros de pipeline para o PipelineDraft; necessário apenas ao criar a partir de um arquivo Pipeline. Valor padrão: None
continue_on_step_failure	bool Indica se deverá continuar um PipelineRun quando uma execução de etapa falhar na configuração do PipelineDraft; necessário apenas ao criar a partir de um arquivo Pipeline. Valor padrão: None
tags	Dict[str, str] Um dicionário de marcas opcional para o PipelineDraft, necessário apenas ao criar a partir de um arquivo Pipeline. Valor padrão: None
properties	Dict[str, str] Dicionário de propriedades opcionais para o PipelineDraft, necessário apenas ao criar a partir de um arquivo 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
PipelineDraft	O PipelineDraft criado.

delete

Exclui 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

Obtém o PipelineDraft com a ID fornecida.

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

Parâmetros

Nome	Description
workspace Obrigatório	Workspace 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
PipelineDraft	Objeto PipelineDraft

get_graph

Obter o gráfico 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
Graph	O objeto de gráfico.

list

Obtém todos os rascunhos de pipeline em um workspace.

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

Parâmetros

Nome	Description
workspace Obrigatório	Workspace O workspace do qual listar os rascunhos.
tags	dict Se especificado, retorna os rascunhos correspondentes ao {"tag": "value"} especificado. 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
list	Uma lista de objetos PipelineDraft.

publish

Publica 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
PublishedPipeline	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 no qual salvar o YAML. Se o caminho for um diretório, o arquivo YAML do PipelineDraft será salvo em path/pipeline_name.yml. Se o caminho for None, será usado o diretório atual. 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
None

submit_run

Envia 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
PipelineRun	O PipelineRun enviado.

update

Atualiza 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	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	Dict[str, str] Um dicionário de marcas para o PipelineDraft. Valor padrão: None
pipeline_parameters	Dict[str, str] As atribuições de parâmetro de pipeline para o PipelineDraft. Valor padrão: None
continue_on_step_failure	bool Se deverá continuar PipelineRun quando a execução de uma 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

Obtém a descrição do PipelineDraft.

Retornos

Tipo	Description
str	A cadeia de caracteres da descrição.

id

Obtém a ID do PipelineDraft.

Retornos

Tipo	Description
str	A ID.

last_submitted_pipeline_run_id

Obtém a ID da última PipelineRun enviada do PipelineDraft.

Retornos

Tipo	Description
str	A ID do PipelineRun.

name

O nome do PipelineDraft.

Retornos

Tipo	Description
str	O nome.

parent_pipeline_draft_id

Obtém 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

Obtém a ID do PipelineRun pai do PipelineDraft.

Retornos

Tipo	Description
str	A ID do PipelineRun.

parent_step_run_ids

Obtém a lista das IDs de StepRun do PipelineRun pai do PipelineDraft.

Retornos

Tipo	Description
list	Uma lista de IDs de StepRun.

properties

Obtém as propriedades do PipelineDraft.

Retornos

Tipo	Description
dict	O dicionário de propriedades.

Compartilhar via

PipelineDraft Classe

Construtor

Parâmetros

Comentários

Métodos

create

Parâmetros

Retornos

delete

Parâmetros

get

Parâmetros

Retornos

get_graph

Parâmetros

Retornos

list

Parâmetros

Retornos

publish

Parâmetros

Retornos

save

Parâmetros

Retornos

submit_run

Parâmetros

Retornos

update

Parâmetros

Atributos

description

Retornos

id

Retornos

last_submitted_pipeline_run_id

Retornos

name

Retornos

parent_pipeline_draft_id

Retornos

parent_pipeline_id

Retornos

parent_pipeline_run_id

Retornos

parent_step_run_ids

Retornos

properties

Retornos

tags

Retornos

Comentários

Recursos adicionais