Freigeben über


PipelineJob Klasse

Pipelineauftrag.

Sie sollten diese Klasse nicht direkt instanziieren. Stattdessen sollten Sie den @pipeline Decorator verwenden, um einen Pipelineauftrag zu erstellen.

] :p aram Compute: Computezielname der erstellten Pipeline. Standardmäßig ist None :type compute: str :p aram tags: Tagwörterbuch. Tags können hinzugefügt, entfernt und aktualisiert werden. Standardmäßig keine :type tags: dict[str, str] :p aram kwargs: Ein Wörterbuch mit zusätzlichen Konfigurationsparametern. Standardwert: None :type kwargs: dict

Vererbung
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

Konstruktor

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)

Parameter

component
Union[str, PipelineComponent]
Erforderlich

Pipelinekomponentenversion. Das Feld schließt sich gegenseitig mit "Aufträgen" aus.

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

Eingaben für den Pipelineauftrag.

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

Ausgaben des Pipelineauftrags.

name
str
Erforderlich

Name des Pipelineauftrags. Standardwert auf "Keine"

description
str
Erforderlich

Beschreibung des Pipelineauftrags. Standardwert auf "Keine"

display_name
str
Erforderlich

Anzeigename des Pipelineauftrags. Standardwert auf "Keine"

experiment_name
str
Erforderlich

Name des Experiments, unter dem der Auftrag erstellt wird. Wenn Keine angegeben ist, wird das Experiment auf das aktuelle Verzeichnis festgelegt. Standardwert auf "Keine"

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

Name des Pipelinekomponentenknotens zum Komponentenobjekt. Standardwert auf "Keine"

settings
PipelineJobSettings
Erforderlich

Einstellung des Pipelineauftrags. Standardwert auf "Keine"

identity
Union[ ManagedIdentityConfiguration, AmlTokenConfiguration, UserIdentityConfiguration
Erforderlich

Identität, die der Trainingsauftrag während der Ausführung auf compute verwendet. Standardwert auf "Keine"

Beispiele

Zeigt, wie eine Pipeline mit dieser Klasse erstellt wird.


   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)

Methoden

dump

Gibt den Auftragsinhalt in eine Datei im YAML-Format ab.

dump

Gibt den Auftragsinhalt in eine Datei im YAML-Format ab.

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

Parameter

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

Der lokale Pfad oder Dateistream, in den der YAML-Inhalt geschrieben werden soll. Wenn dest ein Dateipfad ist, wird eine neue Datei erstellt. Wenn dest eine geöffnete Datei ist, wird die Datei direkt in geschrieben.

kwargs
dict

Zusätzliche Argumente, die an den YAML-Serialisierer übergeben werden sollen.

Ausnahmen

Wird ausgelöst, wenn dest ein Dateipfad ist und die Datei bereits vorhanden ist.

Wird ausgelöst, wenn dest eine geöffnete Datei ist und die Datei nicht beschreibbar ist.

Attribute

base_path

Der Basispfad der Ressource.

Gibt zurück

Der Basispfad der Ressource.

Rückgabetyp

str

creation_context

Der Erstellungskontext der Ressource.

Gibt zurück

Die Erstellungsmetadaten für die Ressource.

Rückgabetyp

id

Die Ressourcen-ID.

Gibt zurück

Die globale ID der Ressource, eine Arm-ID (Azure Resource Manager).

Rückgabetyp

inputs

Eingaben des Pipelineauftrags.

Gibt zurück

Eingaben des Pipelineauftrags.

Rückgabetyp

jobs

Gibt Aufträge des Pipelineauftrags zurück.

Gibt zurück

Aufträge des Pipelineauftrags.

Rückgabetyp

log_files

Auftragsausgabedateien.

Gibt zurück

Das Wörterbuch der Protokollnamen und URLs.

Rückgabetyp

outputs

Ausgaben des Pipelineauftrags.

Gibt zurück

Ausgaben des Pipelineauftrags.

Rückgabetyp

settings

Einstellungen des Pipelineauftrags.

Gibt zurück

Einstellungen des Pipelineauftrags.

Rückgabetyp

status

Der Status des Auftrags.

Zu den häufig zurückgegebenen Werten zählen „Running“ (Wird ausgeführt), „Completed“ (Abgeschlossen) und „Failed“ (Fehlgeschlagen). Alle möglichen Werte sind:

  • NotStarted: Dies ist ein temporärer Zustand, in dem sich clientseitige Run-Objekte vor der Cloudübermittlung befinden.

  • Starting: Die Verarbeitung der Ausführung in der Cloud hat begonnen. Die aufrufende Funktion besitzt zu diesem Zeitpunkt eine Ausführungs-ID.

  • Bereitstellung: Bedarfsgesteuerte Computeerstellung wird für eine bestimmte Auftragsübermittlung erstellt.

  • Vorbereitung: Die Ausführungsumgebung wird vorbereitet und befindet sich in einer von zwei Phasen:

    • Docker-Imagebuild

    • Einrichten der Conda-Umgebung

  • Warteschlangen: Der Auftrag wird auf dem Computeziel in die Warteschlange gestellt. In BatchAI befindet sich der Auftrag beispielsweise in einer Warteschlange.

    während darauf gewartet wird, dass alle angeforderten Knoten bereit sind.

  • Ausführen: Der Auftrag wurde auf dem Computeziel ausgeführt.

  • Abschluss: Die Ausführung des Benutzercodes wurde abgeschlossen, und die Ausführung befindet sich in Nachverarbeitungsphasen.

  • CancelRequested: Für den Auftrag wurde ein Abbruch angefordert.

  • Abgeschlossen: Die Ausführung wurde erfolgreich abgeschlossen. Dies umfasst sowohl die Ausführung von Benutzercode als auch die Ausführung.

    Nachbearbeitungsphasen der Ausführung ein.

  • Failed: Die Ausführung ist fehlgeschlagen. In der Regel liefert die Eigenschaft „Error“ einer Ausführung Details zur Ursache.

  • Canceled: Folgt einer Abbruchanforderung und gibt an, dass die Ausführung jetzt erfolgreich abgebrochen wurde.

  • „NotResponding“ (Reagiert nicht): Für eine Ausführung, für die Heartbeats aktiviert ist, wurde vor Kurzem kein Heartbeat gesendet.

Gibt zurück

Status des Auftrags.

Rückgabetyp

studio_url

Azure ML Studio-Endpunkt.

Gibt zurück

Die URL der Auftragsdetailseite.

Rückgabetyp

type

Der Typ des Auftrags.

Gibt zurück

Der Typ des Auftrags.

Rückgabetyp