Partager via

PipelineJob Classe

  • Référence

Travail de pipeline.

Vous ne devez pas instancier cette classe directement. Au lieu de cela, vous devez utiliser l '@pipeline décorateur pour créer un PipelineJob.

] :p aram compute : nom de la cible de calcul du pipeline généré. La valeur par défaut est None :type compute : str :p aram tags : Tag dictionary. Les balises peuvent être ajoutées, supprimées et mises à jour. La valeur par défaut est None :type tags : dict[str, str] :p aram kwargs : dictionnaire de paramètres de configuration supplémentaires. La valeur par défaut est None :type kwargs : dict

Héritage
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

Constructeur

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)

Paramètres

component
Union[str, PipelineComponent]
Obligatoire

Version du composant de pipeline. Le champ s’exclue mutuellement avec « jobs ».

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

Entrées dans le travail de pipeline.

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

Sorties du travail de pipeline.

name
str
Obligatoire

Nom du pipelineJob. La valeur par défaut est None

description
str
Obligatoire

Description du travail de pipeline. La valeur par défaut est None

display_name
str
Obligatoire

Nom d’affichage de la tâche de pipeline. La valeur par défaut est None

experiment_name
str
Obligatoire

Nom de l’expérience sous laquelle le travail sera créé. Si Aucun est fourni, l’expérience est définie sur le répertoire actif. La valeur par défaut est None

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

Nom du nœud du composant de pipeline vers l’objet de composant. La valeur par défaut est None

settings
PipelineJobSettings
Obligatoire

Paramètre du travail de pipeline. La valeur par défaut est None

identity
Union[ ManagedIdentityConfiguration, AmlTokenConfiguration, UserIdentityConfiguration
Obligatoire

Identité que le travail d’entraînement utilisera lors de l’exécution sur le calcul. La valeur par défaut est None

Exemples

Montre comment créer un pipeline à l’aide de cette classe.


   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éthodes

dump

Vide le contenu du travail dans un fichier au format YAML.

dump

Vide le contenu du travail dans un fichier au format YAML.

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

Paramètres

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

Chemin d’accès local ou flux de fichiers dans lequel écrire le contenu YAML. Si dest est un chemin de fichier, un nouveau fichier est créé. Si dest est un fichier ouvert, le fichier est écrit directement dans.

kwargs
dict

Arguments supplémentaires à passer au sérialiseur YAML.

Exceptions

FileExistsError

Déclenché si dest est un chemin de fichier et que le fichier existe déjà.

IOError

Déclenché si dest est un fichier ouvert et que le fichier n’est pas accessible en écriture.

Attributs

base_path

Chemin d’accès de base de la ressource.

Retours

Chemin d’accès de base de la ressource.

Type de retour

str

creation_context

Contexte de création de la ressource.

Retours

Métadonnées de création pour la ressource.

Type de retour

Optional[SystemData]

id

ID de la ressource.

Retours

ID global de la ressource, id Azure Resource Manager (ARM).

Type de retour

Optional[str]

inputs

Entrées du travail de pipeline.

Retours

Entrées du travail de pipeline.

Type de retour

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

jobs

Retourne les travaux du travail de pipeline.

Retours

Travaux du travail de pipeline.

Type de retour

dict

log_files

Fichiers de sortie de travail.

Retours

Dictionnaire des noms de journaux et des URL.

Type de retour

Optional[Dict[str, str]]

outputs

Sorties du travail de pipeline.

Retours

Sorties du travail de pipeline.

Type de retour

dict[str, Union[str, Output]]

settings

Paramètres du travail de pipeline.

Retours

Paramètres du travail de pipeline.

Type de retour

PipelineJobSettings

status

État du travail.

Les valeurs courantes retournées sont « Exécution en cours (Running) », « Terminé (Finished) » et « Échec (Failed) ». Toutes les valeurs possibles sont les suivantes :

  • NotStarted : il s’agit d’un état temporaire dans lequel se trouvent les objets Run côté client avant la soumission cloud.

  • Démarrage : l’exécution a commencé à être traitée dans le cloud. L’appelant a un ID d’exécution à ce stade.

  • Approvisionnement : le calcul à la demande est en cours de création pour une soumission de travail donnée.

  • Préparation : l’environnement d’exécution est en cours de préparation et se trouve dans l’une des deux étapes suivantes :

    • Build d’image Docker

    • Configuration de l’environnement Conda

  • Mis en file d’attente : le travail est mis en file d’attente sur la cible de calcul. Par exemple, dans BatchAI, le travail est dans un état mis en file d’attente

    en attendant que tous les nœuds demandés soient prêts.

  • En cours d’exécution : le travail a commencé à s’exécuter sur la cible de calcul.

  • Finalisation : l’exécution du code utilisateur est terminée et l’exécution est en phase de post-traitement.

  • CancelRequested : l’annulation a été demandée pour le travail.

  • Terminé : l’exécution s’est terminée avec succès. Cela inclut à la fois l’exécution et l’exécution du code utilisateur

    Étapes de post-traitement.

  • Failed (Échec) : l’exécution a échoué. En règle générale, la propriété Error d’une exécution fournit des détails sur la raison de l’échec.

  • Annulé : suit une demande d’annulation et indique que l’exécution a bien été annulée.

  • NotResponding : pour les exécutions pour lesquelles des pulsations sont activées, aucune pulsation n’a été envoyée récemment.

Retours

État du travail.

Type de retour

Optional[str]

studio_url

Point de terminaison Azure ML Studio.

Retours

URL de la page des détails du travail.

Type de retour

Optional[str]

type

Type du travail.

Retours

Type du travail.

Type de retour

Optional[str]