Share via

PipelineJob Classe

  • Riferimento

Processo della pipeline.

Non è consigliabile creare direttamente un'istanza di questa classe. È invece consigliabile usare l' @pipeline decorator per creare un oggetto PipelineJob.

] :p aram compute: nome di destinazione di calcolo della pipeline compilata. Impostazione predefinita su None :type compute: str :p aram tag: Dizionario tag. I tag possono essere aggiunti, rimossi e aggiornati. Il valore predefinito è None :type tags: dict[str, str] :p aram kwargs: dizionario di parametri di configurazione aggiuntivi. Impostazione predefinita none :type kwargs: dict

Ereditarietà
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

Costruttore

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)

Parametri

component
Union[str, PipelineComponent]
Necessario

Versione del componente della pipeline. Il campo si escludono a vicenda con "processi".

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

Input al processo della pipeline.

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

Output del processo della pipeline.

name
str
Necessario

Nome della pipelineJob. Impostazione predefinita none

description
str
Necessario

Descrizione del processo della pipeline. Impostazione predefinita none

display_name
str
Necessario

Nome visualizzato del processo della pipeline. Impostazione predefinita none

experiment_name
str
Necessario

Nome dell'esperimento in cui verrà creato il processo. Se None viene fornito, l'esperimento verrà impostato sulla directory corrente. Impostazione predefinita none

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

Nome del nodo componente della pipeline per l'oggetto componente. Impostazione predefinita none

settings
PipelineJobSettings
Necessario

Impostazione del processo della pipeline. Impostazione predefinita none

identity
Union[ ManagedIdentityConfiguration, AmlTokenConfiguration, UserIdentityConfiguration
Necessario

Identità che il processo di training userà durante l'esecuzione nel calcolo. Impostazione predefinita none

Esempio

Illustra come creare una pipeline usando questa 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)

Metodi

dump

Esegue il dump del contenuto del processo in un file in formato YAML.

dump

Esegue il dump del contenuto del processo in un file in formato YAML.

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

Parametri

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

Percorso locale o flusso di file in cui scrivere il contenuto YAML. Se il massimo è un percorso di file, verrà creato un nuovo file. Se il massimo è un file aperto, il file verrà scritto direttamente.

kwargs
dict

Argomenti aggiuntivi da passare al serializzatore YAML.

Eccezioni

FileExistsError

Generato se il numero massimo è un percorso di file e il file esiste già.

IOError

Generato se il massimo è un file aperto e il file non è scrivibile.

Attributi

base_path

Percorso di base della risorsa.

Restituisce

Percorso di base della risorsa.

Tipo restituito

str

creation_context

Contesto di creazione della risorsa.

Restituisce

Metadati di creazione per la risorsa.

Tipo restituito

Optional[SystemData]

id

L'ID della risorsa.

Restituisce

ID globale della risorsa, ID di Azure Resource Manager (ARM).

Tipo restituito

Optional[str]

inputs

Input del processo della pipeline.

Restituisce

Input del processo della pipeline.

Tipo restituito

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

jobs

Restituire i processi del processo della pipeline.

Restituisce

Processi del processo della pipeline.

Tipo restituito

dict

log_files

File di output del processo.

Restituisce

Dizionario di nomi e URL di log.

Tipo restituito

Optional[Dict[str, str]]

outputs

Output del processo della pipeline.

Restituisce

Output del processo della pipeline.

Tipo restituito

dict[str, Union[str, Output]]

settings

Impostazioni del processo della pipeline.

Restituisce

Impostazioni del processo della pipeline.

Tipo restituito

PipelineJobSettings

status

Stato del processo.

I valori comuni restituiti includono "Running", "Completed" e "Failed". Tutti i valori possibili sono:

  • NotStarted: questo è uno stato temporaneo in cui gli oggetti Run lato client si trovano prima dell'invio nel cloud.

  • Avvio: l'esecuzione è stata avviata nell'elaborazione nel cloud. Il chiamante ha un ID di esecuzione a questo punto.

  • Provisioning: l'elaborazione su richiesta viene creata per un invio di processo specificato.

  • Preparazione: l'ambiente di esecuzione è in fase di preparazione ed è in una delle due fasi seguenti:

    • Compilazione di immagini Docker

    • configurazione dell'ambiente conda

  • Accodato: il processo viene accodato nella destinazione di calcolo. Ad esempio, in BatchAI il processo si trova in uno stato in coda

    in attesa che tutti i nodi richiesti siano pronti.

  • Esecuzione: il processo è stato avviato per l'esecuzione nella destinazione di calcolo.

  • Finalizzazione: l'esecuzione del codice utente è stata completata e l'esecuzione è in fasi di post-elaborazione.

  • CancelRequested: l'annullamento è stato richiesto per il processo.

  • Completato: l'esecuzione è stata completata correttamente. Ciò include sia l'esecuzione del codice utente che l'esecuzione

    fasi di post-elaborazione.

  • Impossibile: l'esecuzione non è riuscita. In genere la proprietà Error in un'esecuzione fornisce informazioni dettagliate sul motivo.

  • Annullata: segue una richiesta di annullamento e indica che l'esecuzione è stata annullata correttamente.

  • NotResponding: per le esecuzioni abilitate per Heartbeat, non è stato inviato di recente alcun heartbeat.

Restituisce

Stato del processo.

Tipo restituito

Optional[str]

studio_url

Endpoint di Azure ML Studio.

Restituisce

URL della pagina dei dettagli del processo.

Tipo restituito

Optional[str]

type

Tipo del processo.

Restituisce

Tipo del processo.

Tipo restituito

Optional[str]