JobOperations Klasse

Initiiert eine instance von JobOperations

Diese Klasse sollte nicht direkt instanziiert werden. Verwenden Sie stattdessen das auftrags-Attribut eines MLClient-Objekts.

Vererbung

azure.ai.ml._scope_dependent_operations._ScopeDependentOperations

JobOperations

Konstruktor

JobOperations(operation_scope: OperationScope, operation_config: OperationConfig, service_client_02_2023_preview: AzureMachineLearningWorkspaces, all_operations: OperationsContainer, credential: TokenCredential, **kwargs: Any)

Parameter

operation_scope

<xref:azure.ai.ml._scope_dependent_operations.OperationScope>

Erforderlich

Bereichsvariablen für die Betriebsklassen eines MLClient-Objekts.

operation_config

<xref:azure.ai.ml._scope_dependent_operations.OperationConfig>

Erforderlich

Allgemeine Konfiguration für Betriebsklassen eines MLClient-Objekts.

service_client_02_2023_preview

<xref:azure.ai.ml._restclient.v2023_02_01_preview.AzureMachineLearningWorkspaces>

Erforderlich

Dienstclient, damit Endbenutzer mit Azure Machine Learning-Arbeitsbereichsressourcen arbeiten können.

all_operations

<xref:azure.ai.ml._scope_dependent_operations.OperationsContainer>

Erforderlich

Alle Betriebsklassen eines MLClient-Objekts.

credential

TokenCredential

Erforderlich

Anmeldeinformationen, die für die Authentifizierung verwendet werden sollen.

Methoden

archive	Archiviert einen Auftrag.
begin_cancel	Bricht einen Auftrag ab.
create_or_update	Erstellt oder aktualisiert einen Auftrag. Wenn Entitäten wie Umgebung oder Code inline definiert sind, werden sie zusammen mit dem Auftrag erstellt.
download	Lädt die Protokolle und die Ausgabe eines Auftrags herunter.
get	Ruft eine Auftragsressource ab.
list	Listet Aufträge im Arbeitsbereich auf.
restore	Stellt einen archivierten Auftrag wieder her.
show_services	Ruft Dienste ab, die dem Knoten eines Auftrags zugeordnet sind.
stream	Streamt die Protokolle eines ausgeführten Auftrags.
validate	Hinweis Dies ist eine experimentelle Methode, die sich jederzeit ändern kann. Unter https://aka.ms/azuremlexperimental finden Sie weitere Informationen. Überprüft ein Job-Objekt vor der Übermittlung an den Dienst. Anonyme Ressourcen können erstellt werden, wenn inline definierte Entitäten wie Komponente, Umgebung und Code vorhanden sind. Derzeit werden nur Pipelineaufträge für die Validierung unterstützt.

archive

Archiviert einen Auftrag.

archive(name: str) -> None

Parameter

name

str

Erforderlich

Der Name des Auftrags.

Ausnahmen

ResourceNotFoundError

Wird ausgelöst, wenn kein Auftrag mit dem angegebenen Namen gefunden werden kann.

Beispiele

Archivieren eines Auftrags.

   ml_client.jobs.archive(name=job_name)

begin_cancel

Bricht einen Auftrag ab.

begin_cancel(name: str, **kwargs) -> LROPoller[None]

Parameter

name

str

Erforderlich

Der Name des Auftrags.

Gibt zurück

Ein Poller zum Nachverfolgen des Vorgangs status.

Rückgabetyp

LROPoller[None]

Ausnahmen

ResourceNotFoundError

Wird ausgelöst, wenn kein Auftrag mit dem angegebenen Namen gefunden werden kann.

create_or_update

Erstellt oder aktualisiert einen Auftrag. Wenn Entitäten wie Umgebung oder Code inline definiert sind, werden sie zusammen mit dem Auftrag erstellt.

create_or_update(job: Job, *, description: str | None = None, compute: str | None = None, tags: dict | None = None, experiment_name: str | None = None, skip_validation: bool = False, **kwargs) -> Job

Parameter

job

Job

Erforderlich

Das Auftragsobjekt.

description

Optional[str]

Die Auftragsbeschreibung.

compute

Optional[str]

Das Computeziel für den Auftrag.

tags

Optional[dict]

Die Tags für den Auftrag.

experiment_name

Optional[str]

Der Name des Experiments, unter dem der Auftrag erstellt wird. Wenn Keine angegeben ist, wird der Auftrag im Experiment "Standard" erstellt.

skip_validation

bool

Gibt an, ob die Überprüfung vor dem Erstellen oder Aktualisieren des Auftrags übersprungen werden soll. Beachten Sie, dass die Überprüfung für abhängige Ressourcen, z. B. eine anonyme Komponente, nicht übersprungen wird. Der Standardwert lautet „False“.

Gibt zurück

Erstellter oder aktualisierter Auftrag.

Rückgabetyp

Job

Ausnahmen

Union

UserErrorException

ValidationException

Wird ausgelöst, wenn der Auftrag nicht erfolgreich überprüft werden kann. Details werden in der Fehlermeldung angegeben.

AssetException

Wird ausgelöst, wenn Auftragsressourcen (z. B. Daten, Code, Modell, Umgebung) nicht erfolgreich überprüft werden können. Details werden in der Fehlermeldung angegeben.

ModelException

Wird ausgelöst, wenn das Auftragsmodell nicht erfolgreich überprüft werden kann. Details werden in der Fehlermeldung angegeben.

JobException

Wird ausgelöst, wenn das Job-Objekt oder die Attribute ordnungsgemäß formatiert sind. Details werden in der Fehlermeldung angegeben.

EmptyDirectoryError

Wird ausgelöst, wenn der lokale Pfad auf ein leeres Verzeichnis verweist.

DockerEngineNotAvailableError

Wird ausgelöst, wenn die Docker-Engine für den lokalen Auftrag nicht verfügbar ist.

Beispiele

Erstellen eines neuen Auftrags und anschließendes Aktualisieren des Computes.

   from azure.ai.ml import load_job

   created_job = ml_client.jobs.create_or_update(
       name=job_name,
       job=load_job(
           "./sdk/ml/azure-ai-ml/tests/test_configs/command_job/command_job_test_local_env.yml",
           params_override=[{"name": job_name}, {"compute": "cpucluster"}],
       ),
   )

download

Lädt die Protokolle und die Ausgabe eines Auftrags herunter.

download(name: str, *, download_path: PathLike | str = '.', output_name: str | None = None, all: bool = False) -> None

Parameter

name

str

Erforderlich

Der Name eines Auftrags.

download_path

Union[<xref:PathLike>, str]

Der lokale Pfad, der als Downloadziel verwendet werden soll. Standardmäßig ist ".".

output_name

Optional[str]

Der Name der herunterzuladenden Ausgabe. Der Standardwert ist „None“.

all

bool

Gibt an, ob alle Protokolle und benannten Ausgaben heruntergeladen werden sollen. Der Standardwert lautet „False“.

Ausnahmen

JobException

Wird ausgelöst, wenn sich Der Auftrag noch nicht im Terminalzustand befindet. Details werden in der Fehlermeldung angegeben.

MlException

Wird ausgelöst, wenn Protokolle und Ausgaben nicht erfolgreich heruntergeladen werden können. Details werden in der Fehlermeldung angegeben.

Beispiele

Herunterladen aller Protokolle und benannten Ausgaben des Auftrags "job-1" in das lokale Verzeichnis "job-1-logs".

   ml_client.jobs.download(name=job_name, download_path="./job-1-logs", all=True)

get

Ruft eine Auftragsressource ab.

get(name: str) -> Job

Parameter

name

str

Erforderlich

Der Name des Auftrags.

Gibt zurück

Auftragsobjekt, das aus dem Dienst abgerufen wird.

Rückgabetyp

Job

Ausnahmen

ResourceNotFoundError

Wird ausgelöst, wenn kein Auftrag mit dem angegebenen Namen gefunden werden kann.

UserErrorException

Wird ausgelöst, wenn der name-Parameter keine Zeichenfolge ist.

Beispiele

Abrufen eines Auftrags mit dem Namen "iris-dataset-job-1".

   retrieved_job = ml_client.jobs.get(job_name)

list

Listet Aufträge im Arbeitsbereich auf.

list(*, parent_job_name: str | None = None, list_view_type: ListViewType = ListViewType.ACTIVE_ONLY, **kwargs) -> Iterable[Job]

Parameter

parent_job_name

Optional[str]

Wenn angegeben, werden nur Aufträge zurückgegeben, die untergeordnete Elemente des benannten Auftrags sind. Standardmäßig wird Keine festgelegt, wobei alle Aufträge im Arbeitsbereich aufgelistet werden.

list_view_type

ListViewType

Der Ansichtstyp für das Einschließen/Ausschließen archivierter Aufträge. Standardmäßig wird ~azure.mgt.machinelearningservices.models.ListViewType.ACTIVE_ONLY festgelegt, wobei archivierte Aufträge ausgeschlossen sind.

Gibt zurück

Eine iteratorähnliche instance von Job-Objekten.

Rückgabetyp

ItemPaged[Job]

Ausnahmen

ResourceNotFoundError

Wird ausgelöst, wenn kein Auftrag mit dem angegebenen Namen gefunden werden kann.

Beispiele

Abrufen einer Liste der archivierten Aufträge in einem Arbeitsbereich mit dem übergeordneten Auftrag "iris-dataset-jobs".

   from azure.ai.ml._restclient.v2023_04_01_preview.models import ListViewType

   list_of_jobs = ml_client.jobs.list(parent_job_name=job_name, list_view_type=ListViewType.ARCHIVED_ONLY)

restore

Stellt einen archivierten Auftrag wieder her.

restore(name: str) -> None

Parameter

name

str

Erforderlich

Der Name des Auftrags.

Ausnahmen

ResourceNotFoundError

Wird ausgelöst, wenn kein Auftrag mit dem angegebenen Namen gefunden werden kann.

Beispiele

Wiederherstellen eines archivierten Auftrags.

   ml_client.jobs.restore(name=job_name)

show_services

Ruft Dienste ab, die dem Knoten eines Auftrags zugeordnet sind.

show_services(name: str, node_index: int = 0) -> Dict[str, ServiceInstance]

Parameter

name

str

Erforderlich

Der Name des Auftrags.

node_index

int

Erforderlich

Der Index des Knotens (nullbasiert). Der Standardwert ist 0.

Gibt zurück

Die dem Auftrag für den angegebenen Knoten zugeordneten Dienste.

Rückgabetyp

dict[str, ServiceInstance]

Ausnahmen

ResourceNotFoundError

Wird ausgelöst, wenn kein Auftrag mit dem angegebenen Namen gefunden werden kann.

Beispiele

Abrufen der Dienste, die dem 1. Knoten eines Auftrags zugeordnet sind.

   job_services = ml_client.jobs.show_services(job_name)

stream

Streamt die Protokolle eines ausgeführten Auftrags.

stream(name: str) -> None

Parameter

name

str

Erforderlich

Der Name des Auftrags.

Ausnahmen

ResourceNotFoundError

Wird ausgelöst, wenn kein Auftrag mit dem angegebenen Namen gefunden werden kann.

Beispiele

Streaming eines ausgeführten Auftrags.

   running_job = ml_client.jobs.create_or_update(
       load_job(
           "./sdk/ml/azure-ai-ml/tests/test_configs/command_job/command_job_test_local_env.yml",
           params_override=[{"name": job_name}, {"compute": "cpucluster"}],
       )
   )
   ml_client.jobs.stream(running_job.name)

validate

Hinweis

Dies ist eine experimentelle Methode, die sich jederzeit ändern kann. Unter https://aka.ms/azuremlexperimental finden Sie weitere Informationen.

Überprüft ein Job-Objekt vor der Übermittlung an den Dienst. Anonyme Ressourcen können erstellt werden, wenn inline definierte Entitäten wie Komponente, Umgebung und Code vorhanden sind. Derzeit werden nur Pipelineaufträge für die Validierung unterstützt.

validate(job: Job, *, raise_on_failure: bool = False, **kwargs) -> ValidationResult

Parameter

job

Job

Erforderlich

Das zu überprüfende Auftragsobjekt.

raise_on_failure

bool

Gibt an, ob ein Fehler ausgelöst werden soll, wenn die Überprüfung fehlschlägt. Der Standardwert lautet „False“.

Gibt zurück

Ein ValidationResult-Objekt, das alle gefundenen Fehler enthält.

Rückgabetyp

ValidationResult

Ausnahmen

ResourceNotFoundError

Wird ausgelöst, wenn kein Auftrag mit dem angegebenen Namen gefunden werden kann.

Beispiele

Überprüfen eines PipelineJob-Objekts und Drucken der gefundenen Fehler

   from azure.ai.ml import load_job
   from azure.ai.ml.entities import PipelineJob

   pipeline_job: PipelineJob = load_job(
       "./sdk/ml/azure-ai-ml/tests/test_configs/pipeline_jobs/invalid/combo.yml",
       params_override=[{"name": job_name}, {"compute": "cpucluster"}],
   )
   print(ml_client.jobs.validate(pipeline_job).error_messages)