PublishedPipeline Clase

Representa una canalización que se va a enviar sin el código de Python que lo construyó.

Además, se puede usar publishedPipeline para volver a enviar un Pipeline con valores y entradas diferentes PipelineParameter .

Inicialice PublishedPipeline.

:p aram punto de conexión La dirección URL del punto de conexión REST para enviar ejecuciones de canalización para esta canalización. :type endpoint: str :p aram total_run_steps: el número de pasos de esta canalización :type total_run_steps: int :p aram workspace: el área de trabajo de la canalización publicada. :type workspace: azureml.core.Workspace :p aram continue_on_step_failure: Si desea continuar la ejecución de otros pasos en PipelineRun

si se produce un error en un paso, el valor predeterminado es false.

Constructor

PublishedPipeline(name, graph_id, description, version, published_pipeline_id, status, endpoint, total_run_steps, workspace, continue_on_step_failure=None, _pipeline_provider=None, **kwargs)

Parámetros

Nombre	Description
name Requerido	str Nombre de la canalización publicada.
graph_id Requerido	str Identificador del gráfico de esta canalización publicada.
description Requerido	str Descripción de la canalización publicada.
version Requerido	str Versión de canalización publicada.
published_pipeline_id Requerido	str Identificador de la canalización publicada.
status Requerido	str Estado de la canalización publicada ("Activo" o "Deshabilitado").
endpoint Requerido	str Dirección URL del punto de conexión de REST para enviar ejecuciones para esta canalización.
total_run_steps Requerido	int Número de pasos de esta canalización.
workspace Requerido	Workspace Área de trabajo de la canalización publicada.
continue_on_step_failure Requerido	bool Si desea continuar la ejecución de otros pasos en PipelineRun si se produce un error en un paso. El valor predeterminado es false.
_pipeline_provider Requerido	<xref:azureml.pipeline.core._workflow_provider._PublishedPipelineProvider> Proveedor de canalización publicado.
kwargs Requerido	dict Argumentos de palabra clave personalizados, reservados para el desarrollo futuro
name Requerido	str Nombre de la canalización publicada.
graph_id Requerido	str Identificador del gráfico de esta canalización publicada.
description Requerido	str Descripción de la canalización publicada.
version Requerido	str Versión de canalización publicada.
published_pipeline_id Requerido	str Identificador de la canalización publicada.
status Requerido	str Estado de la canalización publicada ("Activo" o "Deshabilitado").
_pipeline_provider Requerido	<xref:azureml.pipeline.core._workflow_provider._PublishedPipelineProvider> Proveedor de canalización publicado.
kwargs Requerido	dict Argumentos de palabra clave personalizados, reservados para el desarrollo futuro

Comentarios

Se puede crear una clase PublishedPipeline a partir de o Pipeline .PipelineRun

Un ejemplo para publicar desde una canalización es el siguiente:


   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)

Para publicar desde una canalizaciónEjecutar uso:


   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: el parámetro continue_on_step_failure especifica si la ejecución de los pasos de la canalización continuará si se produce un error en un paso. El valor predeterminado es False, lo que significa que cuando se produce un error en un paso, la ejecución de la canalización se detendrá y cancelará los pasos en ejecución.

Envíe una clase PublishedPipeline mediante submit. Cuando se llama a submit, se crea un PipelineRun objeto que, a su vez, crea StepRun objetos para cada paso del flujo de trabajo.

Un ejemplo para enviar un objeto PublishedPipeline es el siguiente:


   from azureml.pipeline.core import PublishedPipeline

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

Hay una serie de opciones opcionales que se pueden especificar al enviar una propiedad PublishedPipeline. Estos incluyen:

continue_on_step_failure: si desea continuar la ejecución de otros pasos en PipelineRun si se produce un error en un paso, opcional. Solo los pasos que no tienen ninguna dependencia en la salida del paso con errores continuarán la ejecución. Si se proporciona, esta configuración de parámetro invalida la configuración en la canalización.
pipeline_parameters: parámetros para la ejecución de la canalización, diccionario de {name: value}. Consulte PipelineParameter para obtener más detalles.
parent_run_id: puede proporcionar un identificador de ejecución para establecer la ejecución primaria de esta ejecución de canalización, que se refleja en RunHistory. La ejecución primaria debe pertenecer al mismo experimento que la canalización que se envía.

Un ejemplo para enviar una propiedad PublishedPipeline mediante esta configuración es la siguiente:


   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>")

Todas las canalizaciones publicadas tienen un punto de conexión REST. Con el punto de conexión de canalización, puede desencadenar una ejecución de la canalización desde sistemas externos, como clientes que no son de Python. Para obtener información sobre cómo autenticarse al llamar a puntos de conexión REST, consulte https://aka.ms/pl-restep-auth.

El uso del punto de conexión habilita la "repetibilidad administrada" en escenarios de puntuación por lotes y reentrenamiento, por ejemplo. Para obtener más información, consulte https://aka.ms/pl-first-pipeline.

Métodos

disable	Establezca la canalización publicada en "Disabled" (Deshabilitado) y no esté disponible para ejecutarse.
enable	Establezca la canalización publicada en "Activo" y esté disponible para ejecutarse.
get	Obtenga la canalización publicada.
get_all	Obtenga todas las canalizaciones publicadas en el área de trabajo actual. EN DESUSO: este método está en desuso en favor del método PublishedPipeline list .
get_graph	Obtenga el gráfico de PublishedPipeline.
get_step_names	Obtenga la lista de nombres de pasos en PublishedPipeline.
list	Obtenga todas las canalizaciones publicadas en el área de trabajo actual.
save	Guarde yaML de canalización en un archivo. Actualmente, solo se admiten canalizaciones que constan de ModuleSteps para la exportación de YAML.
submit	Envíe la canalización publicada. Esto equivale a usar submit. Devuelve el objeto enviado PipelineRun. Use este objeto para supervisar y ver los detalles de la ejecución.

disable

Establezca la canalización publicada en "Disabled" (Deshabilitado) y no esté disponible para ejecutarse.

disable()

enable

Establezca la canalización publicada en "Activo" y esté disponible para ejecutarse.

enable()

get

Obtenga la canalización publicada.

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ó la canalización publicada.
id Requerido	str Identificador de la canalización publicada.
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Proveedor de flujo de trabajo. Valor predeterminado: None
_service_endpoint	str Punto de conexión de servicio. Valor predeterminado: None

Devoluciones

Tipo	Description
PublishedPipeline	Objeto PublishedPipeline.

get_all

Obtenga todas las canalizaciones publicadas en el área de trabajo actual.

EN DESUSO: este método está en desuso en favor del método PublishedPipeline list .

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

Parámetros

Nombre	Description
workspace Requerido	Workspace Área de trabajo en la que se creó la canalización publicada.
active_only	bool Si solo se devuelven canalizaciones publicadas que están activas actualmente. Valor predeterminado: True
_service_endpoint	str Punto de conexión de servicio. Valor predeterminado: None

Devoluciones

Tipo	Description
list[PublishedPipeline]	Lista de objetos PublishedPipeline.

get_graph

Obtenga el gráfico de PublishedPipeline.

get_graph(_workflow_provider=None)

Parámetros

Nombre	Description
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Proveedor de flujo de trabajo. Valor predeterminado: None

Devoluciones

Tipo	Description
Graph	Gráfico.

get_step_names

Obtenga la lista de nombres de pasos en PublishedPipeline.

get_step_names(_workflow_provider=None)

Parámetros

Nombre	Description
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Proveedor de flujo de trabajo. Valor predeterminado: None

Devoluciones

Tipo	Description
List[str]	Lista de los nombres de los pasos de PublishedPipeline.

list

Obtenga todas las canalizaciones publicadas en el área de trabajo actual.

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

Parámetros

Nombre	Description
workspace Requerido	Workspace Área de trabajo en la que se creó la canalización publicada.
active_only	bool Si solo se devuelven canalizaciones publicadas que están activas actualmente. Valor predeterminado: True
_service_endpoint	str Punto de conexión de servicio. Valor predeterminado: None

Devoluciones

Tipo	Description
list[PublishedPipeline]	Lista de objetos PublishedPipeline.

save

Guarde yaML de canalización en un archivo.

Actualmente, solo se admiten canalizaciones que constan de ModuleSteps para la exportación de YAML.

save(path=None, _workflow_provider=None)

Parámetros

Nombre	Description
path	str Ruta de acceso a la que se va a guardar YAML. Si la ruta de acceso es un directorio, el archivo YAML de canalización se guarda en la ruta de acceso o pipeline_name.yml. Si la ruta de acceso es None, se usa el directorio actual. Valor predeterminado: None
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Proveedor de flujo de trabajo. Valor predeterminado: None

Devoluciones

Tipo	Description
None

submit

Envíe la canalización publicada. Esto equivale a usar submit.

Devuelve el objeto enviado PipelineRun. Use este objeto para supervisar y ver los detalles de la ejecución.

submit(workspace, experiment_name, pipeline_parameters=None, _workflow_provider=None, _service_endpoint=None, parent_run_id=None, continue_on_step_failure=None)

Parámetros

Nombre	Description
workspace Requerido	Workspace Área de trabajo en la que se va a enviar la canalización publicada.
experiment_name Requerido	str Nombre del experimento al que se va a enviar.
pipeline_parameters	dict Diccionario de parámetros para asignar nuevos valores {nombre del parámetro, valor del parámetro}. Consulte PipelineParameter para obtener más detalles. Valor predeterminado: None
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> Proveedor de flujo de trabajo. Valor predeterminado: None
_service_endpoint	str Punto de conexión de servicio. Valor predeterminado: None
parent_run_id	str Identificador de ejecución opcional que se va a establecer para la ejecución primaria de esta ejecución de canalización, que se refleja en RunHistory. La ejecución primaria debe pertenecer al mismo experimento al que se envía esta canalización. Valor predeterminado: None
continue_on_step_failure	bool Si desea continuar la ejecución de otros pasos en PipelineRun si se produce un error en un paso, opcional. Si se proporciona, invalidará la configuración en la canalización. Valor predeterminado: None

Devoluciones

Tipo	Description
PipelineRun	La ejecución de la canalización enviada.

Atributos

continue_on_step_failure

Obtenga el valor de la continue_on_step_failure configuración.

Devoluciones

Tipo	Description
bool	Valor de la `continue_on_step_failure` configuración.

description

Obtenga la descripción de la canalización publicada.

Devoluciones

Tipo	Description
str	Descripción de la canalización publicada.

endpoint

Obtenga la dirección URL del punto de conexión rest para ejecutar una canalización publicada.

Devoluciones

Tipo	Description
str	Dirección URL del punto de conexión de REST para ejecutar la canalización publicada.

graph_id

Obtenga el identificador del grafo de esta canalización publicada.

Devoluciones

Tipo	Description
str	Identificador del grafo.

id

Obtenga el identificador de canalización publicado.

Devoluciones

Tipo	Description
str	Identificador de la canalización publicada.

name

Obtenga el nombre de la canalización publicada.

Devoluciones

Tipo	Description
str	Nombre de canalización publicado.

status

Obtenga el estado de la canalización publicada.

Devoluciones

Tipo	Description
str	Estado de la canalización publicada.

total_run_steps

Obtenga el número de pasos de la canalización.

Devoluciones

Tipo	Description
int	Número de pasos de la canalización.

version

Obtenga la versión de la canalización publicada.

Devoluciones

Tipo	Description
str	Versión de la canalización publicada.

Compartir a través de

PublishedPipeline Clase

Constructor

Parámetros

Comentarios

Métodos

disable

enable

get

Parámetros

Devoluciones

get_all

Parámetros

Devoluciones

get_graph

Parámetros

Devoluciones

get_step_names

Parámetros

Devoluciones

list

Parámetros

Devoluciones

save

Parámetros

Devoluciones

submit

Parámetros

Devoluciones

Atributos

continue_on_step_failure

Devoluciones

description

Devoluciones

endpoint

Devoluciones

graph_id

Devoluciones

id

Devoluciones

name

Devoluciones

status

Devoluciones

total_run_steps

Devoluciones

version

Devoluciones

Comentarios