Share via

PipelineJob Clase

  • Referencia

Trabajo de canalización.

No debe crear una instancia de esta clase directamente. En su lugar, debe usar el decorador @pipeline para crear un PipelineJob.

] :p aram compute: nombre de destino de proceso de la canalización compilada. El valor predeterminado es None :type compute: str :p aram tags: Tag dictionary. Las etiquetas se pueden agregar, quitar y actualizar. El valor predeterminado es None :type tags: dict[str, str] :p aram kwargs: diccionario de parámetros de configuración adicionales. El valor predeterminado es None :type kwargs: dict

Herencia
azure.ai.ml.entities._job.job.Job
PipelineJob
azure.ai.ml.entities._mixins.YamlTranslatableMixin
PipelineJob
azure.ai.ml.entities._job.pipeline._io.mixin.PipelineJobIOMixin
PipelineJob
azure.ai.ml.entities._validation.path_aware_schema.PathAwareSchemaValidatableMixin
PipelineJob

Constructor

PipelineJob(*, component: str | PipelineComponent | None = None, inputs: Dict[str, int | str | float | bool | Input] | None = None, outputs: Dict[str, Output] | None = None, name: str | None = None, description: str | None = None, display_name: str | None = None, experiment_name: str | None = None, jobs: Dict[str, BaseNode] | None = None, settings: PipelineJobSettings | None = None, identity: ManagedIdentityConfiguration | AmlTokenConfiguration | UserIdentityConfiguration | None = None, compute: str | None = None, tags: Dict[str, str] | None = None, **kwargs)

Parámetros

component
Union[str, PipelineComponent]
Requerido

Versión del componente de canalización. El campo es mutuamente excluyente con "trabajos".

inputs
dict[str, Union[<xref:azure.ai.ml.entities.Input>, str, bool, int, float]]
Requerido

Entradas para el trabajo de canalización.

outputs
dict[str, <xref:azure.ai.ml.entities.Output>]
Requerido

Salidas del trabajo de canalización.

name
str
Requerido

Nombre del pipelineJob. El valor predeterminado es None

description
str
Requerido

Descripción del trabajo de canalización. El valor predeterminado es None

display_name
str
Requerido

Nombre para mostrar del trabajo de canalización. El valor predeterminado es None

experiment_name
str
Requerido

Nombre del experimento en el que se creará el trabajo. Si se proporciona Ninguno, el experimento se establecerá en el directorio actual. El valor predeterminado es None

jobs
dict[str, <xref:azure.ai.ml.entities._builders.BaseNode>]
Requerido

Nombre del nodo del componente de canalización al objeto de componente. El valor predeterminado es None

settings
PipelineJobSettings
Requerido

Configuración del trabajo de canalización. El valor predeterminado es None

identity
Union[ ManagedIdentityConfiguration, AmlTokenConfiguration, UserIdentityConfiguration
Requerido

Identidad que usará el trabajo de entrenamiento mientras se ejecuta en proceso. El valor predeterminado es None

Ejemplos

Muestra cómo crear una canalización mediante esta clase.


   from azure.ai.ml.entities import PipelineJob, PipelineJobSettings

   pipeline_job = PipelineJob(
       description="test pipeline job",
       tags={},
       display_name="test display name",
       experiment_name="pipeline_job_samples",
       properties={},
       settings=PipelineJobSettings(force_rerun=True, default_compute="cpu-cluster"),
       jobs={"component1": component_func(component_in_number=1.0, component_in_path=uri_file_input)},
   )
   ml_client.jobs.create_or_update(pipeline_job)

Métodos

dump

Volca el contenido del trabajo en un archivo en formato YAML.

dump

Volca el contenido del trabajo en un archivo en formato YAML.

dump(dest: str | PathLike | IO, **kwargs) -> None

Parámetros

dest
Union[<xref:PathLike>, str, IO[AnyStr]]
Requerido

Ruta de acceso local o secuencia de archivos en la que se va a escribir el contenido de YAML. Si dest es una ruta de acceso de archivo, se creará un nuevo archivo. Si dest es un archivo abierto, el archivo se escribirá directamente.

kwargs
dict

Argumentos adicionales para pasar al serializador YAML.

Excepciones

FileExistsError

Se genera si dest es una ruta de acceso de archivo y el archivo ya existe.

IOError

Se genera si dest es un archivo abierto y el archivo no se puede escribir.

Atributos

base_path

Ruta de acceso base del recurso.

Devoluciones

Ruta de acceso base del recurso.

Tipo de valor devuelto

str

creation_context

Contexto de creación del recurso.

Devoluciones

Metadatos de creación del recurso.

Tipo de valor devuelto

Optional[SystemData]

id

El identificador del recurso.

Devoluciones

Identificador global del recurso, un identificador de Azure Resource Manager (ARM).

Tipo de valor devuelto

Optional[str]

inputs

Entradas del trabajo de canalización.

Devoluciones

Entradas del trabajo de canalización.

Tipo de valor devuelto

dict[str, Union[Input, str, bool, int, float]]

jobs

Devuelve trabajos de trabajo de canalización.

Devoluciones

Trabajos de trabajo de canalización.

Tipo de valor devuelto

dict

log_files

Archivos de salida del trabajo.

Devoluciones

Diccionario de nombres de registro y direcciones URL.

Tipo de valor devuelto

Optional[Dict[str, str]]

outputs

Salidas del trabajo de canalización.

Devoluciones

Salidas del trabajo de canalización.

Tipo de valor devuelto

dict[str, Union[str, Output]]

settings

Configuración del trabajo de canalización.

Devoluciones

Configuración del trabajo de canalización.

Tipo de valor devuelto

PipelineJobSettings

status

El estado del trabajo.

Los valores comunes devueltos incluyen "Running", "Completed" y "Failed". Todos los valores posibles son:

  • NotStarted: se trata de un estado temporal en el que se encuentran los objetos Run del lado cliente antes del envío en la nube.

  • Starting: la ejecución ha empezado a procesarse en la nube. El autor de la llamada tiene un identificador de ejecución en este momento.

  • Aprovisionamiento: se crea un proceso a petición para un envío de trabajo determinado.

  • Preparación: el entorno de ejecución se está preparando y se encuentra en una de estas dos fases:

    • Compilación de imágenes de Docker

    • configuración del entorno Conda

  • En cola: el trabajo se pone en cola en el destino de proceso. Por ejemplo, en BatchAI, el trabajo está en un estado en cola.

    mientras espera a que todos los nodos solicitados estén listos.

  • En ejecución: el trabajo se ha iniciado para ejecutarse en el destino de proceso.

  • Finalización: la ejecución del código de usuario se ha completado y la ejecución está en fases posteriores al procesamiento.

  • CancelRequested: se ha solicitado la cancelación del trabajo.

  • Completado: la ejecución se ha completado correctamente. Esto incluye tanto la ejecución del código de usuario como la ejecución

    posteriores al procesamiento de la ejecución.

  • Failed: error en la ejecución. Normalmente, la propiedad Error de una ejecución proporcionará detalles sobre por qué se produjo el error.

  • Canceled: sigue a una solicitud de cancelación e indica que la ejecución se ha cancelado correctamente.

  • NotResponding: en el caso de las ejecuciones que tienen los latidos habilitados, no se ha enviado recientemente ningún latido.

Devoluciones

Estado del trabajo.

Tipo de valor devuelto

Optional[str]

studio_url

Punto de conexión de Azure ML Studio.

Devoluciones

Dirección URL de la página de detalles del trabajo.

Tipo de valor devuelto

Optional[str]

type

Tipo del trabajo.

Devoluciones

Tipo del trabajo.

Tipo de valor devuelto

Optional[str]