Freigeben über

CommandJob Klasse

  • Referenz

Befehlsauftrag.

Vererbung
azure.ai.ml.entities._job.job.Job
CommandJob
azure.ai.ml.entities._job.parameterized_command.ParameterizedCommand
CommandJob
azure.ai.ml.entities._job.job_io_mixin.JobIOMixin
CommandJob

Konstruktor

CommandJob(*, inputs: Dict[str, int | str | float | bool | Input] | None = None, outputs: Dict[str, Output] | None = None, limits: CommandJobLimits | None = None, identity: ManagedIdentityConfiguration | AmlTokenConfiguration | UserIdentityConfiguration | None = None, services: Dict[str, JobService | JupyterLabJobService | SshJobService | TensorBoardJobService | VsCodeJobService] | None = None, **kwargs)

Parameter

services
Optional[dict[str, JobService]]

Schreibgeschützte Informationen zu Diensten, die dem Auftrag zugeordnet sind.

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

Zuordnung von Ausgabedatenbindungen, die im Befehl verwendet werden.

outputs
Optional[dict[str, Output]]

Zuordnung von Ausgabedatenbindungen, die im Auftrag verwendet werden.

identity
Optional[Union[ManagedIdentityConfiguration, AmlTokenConfiguration, UserIdentityConfiguration]]

Die Identität, die der Auftrag während der Ausführung auf Compute verwendet.

limits
Optional[CommandJobLimits]

Die Grenzwerte für den Auftrag.

kwargs
dict

Ein Wörterbuch mit zusätzlichen Konfigurationsparametern.

Beispiele

Konfigurieren eines CommandJobs.


   command_job = CommandJob(
       code="./src",
       command="python train.py --ss {search_space.ss}",
       inputs={"input1": Input(path="trial.csv")},
       outputs={"default": Output(path="./foo")},
       compute="trial",
       environment="AzureML-sklearn-1.0-ubuntu20.04-py38-cpu:33",
       limits=CommandJobLimits(timeout=120),
   )

Methoden

dump

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

dump

Gibt den Auftragsinhalt in einer 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 das YAML-Serialisierungsprogramm übergeben werden sollen.

Ausnahmen

FileExistsError

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

IOError

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

Optional[SystemData]

distribution

Die Konfiguration für die Verteilte Befehlskomponente oder den Auftrag.

Gibt zurück

Die Verteilungskonfiguration.

Rückgabetyp

Union[PyTorchDistribution, MpiDistribution, TensorFlowDistribution, RayDistribution]

id

Die Ressourcen-ID.

Gibt zurück

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

Rückgabetyp

Optional[str]

inputs

log_files

Auftragsausgabedateien.

Gibt zurück

Das Wörterbuch der Protokollnamen und URLs.

Rückgabetyp

Optional[Dict[str, str]]

outputs

parameters

MLFlow-Parameter.

Gibt zurück

MLFlow-Parameter, die im Auftrag angemeldet sind.

Rückgabetyp

dict[str, str]

resources

Die Computeressourcenkonfiguration für die Befehlskomponente oder den Auftrag.

Gibt zurück

Die Computeressourcenkonfiguration für die Befehlskomponente oder den Auftrag.

Rückgabetyp

JobResourceConfiguration

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 Computeressourcen werden für eine bestimmte Auftragsübermittlung erstellt.

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

    • Docker-Imagebuild

    • Einrichten der Conda-Umgebung

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

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

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

  • Abgeschlossen: Die Ausführung des Benutzercodes wurde abgeschlossen, und die Ausführung befindet sich in den Phasen nach der Verarbeitung.

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

  • Abgeschlossen: Die Ausführung wurde erfolgreich abgeschlossen. Dies schließt sowohl die Ausführung von Benutzercode als auch die Ausführung ein.

    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

Optional[str]

studio_url

Azure ML Studio-Endpunkt.

Gibt zurück

Die URL zur Auftragsdetailseite.

Rückgabetyp

Optional[str]

type

Der Typ des Auftrags.

Gibt zurück

Der Typ des Auftrags.

Rückgabetyp

Optional[str]