JobOperations Osztály

A JobOperations egy példányát kezdeményezi

Ezt az osztályt nem szabad közvetlenül példányosítani. Ehelyett használja egy MLClient objektum jobs attribútumát.

Öröklődés

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)

Paraméterek

operation_scope

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

Kötelező

Hatókörváltozók egy MLClient objektum műveleti osztályaihoz.

operation_config

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

Kötelező

Az MLClient objektum műveleti osztályainak gyakori konfigurációja.

service_client_02_2023_preview

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

Kötelező

Szolgáltatásügyfél, amely lehetővé teszi a végfelhasználók számára az Azure Machine Learning-munkaterület erőforrásainak használatát.

all_operations

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

Kötelező

Egy MLClient objektum összes műveleti osztálya.

credential

TokenCredential

Kötelező

Hitelesítéshez használandó hitelesítő adatok.

Metódusok

archive	Archivál egy munkát.
begin_cancel	Megszakít egy feladatot.
create_or_update	Feladat létrehozása vagy frissítése. Ha az entitások, például a Környezet vagy a Kód beágyazott módon vannak definiálva, akkor a feladattal együtt jönnek létre.
download	Letölti egy feladat naplóit és kimenetét.
get	Lekér egy feladaterőforrást.
list	Felsorolja a munkaterületen lévő feladatokat.
restore	Archivált feladat visszaállítása.
show_services	Lekéri a feladat csomópontjával társított szolgáltatásokat.
stream	Streameli egy futó feladat naplóit.
validate	Megjegyzés Ez egy kísérleti módszer, és bármikor változhat. További információ: https://aka.ms/azuremlexperimental. Ellenőrzi a Feladat objektumot, mielőtt elküldené a szolgáltatást. Névtelen adategységek akkor hozhatók létre, ha beágyazott entitások vannak, például Összetevő, Környezet és Kód. Jelenleg csak a folyamatfeladatok támogatottak az ellenőrzéshez.

archive

Archivál egy munkát.

archive(name: str) -> None

Paraméterek

name

str

Kötelező

A feladat neve.

Kivételek

ResourceNotFoundError

Akkor kerül elő, ha nem található a megadott nevű feladat.

Példák

Feladat archiválása.

   ml_client.jobs.archive(name=job_name)

begin_cancel

Megszakít egy feladatot.

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

Paraméterek

name

str

Kötelező

A feladat neve.

Válaszok

Egy lekérdezés a művelet állapotának nyomon követéséhez.

Visszatérési típus

LROPoller[None]

Kivételek

ResourceNotFoundError

Akkor kerül elő, ha nem található a megadott nevű feladat.

create_or_update

Feladat létrehozása vagy frissítése. Ha az entitások, például a Környezet vagy a Kód beágyazott módon vannak definiálva, akkor a feladattal együtt jönnek létre.

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

Paraméterek

job

Job

Kötelező

A feladatobjektum.

description

Optional[str]

A feladat leírása.

compute

Optional[str]

A feladat számítási célja.

tags

Optional[dict]

A feladat címkéi.

experiment_name

Optional[str]

Annak a kísérletnek a neve, amelyben a feladat létrejön. Ha nincs megadva, a feladat az "Alapértelmezett" kísérlet alatt jön létre.

skip_validation

bool

Megadja, hogy kihagyja-e az érvényesítést a feladat létrehozása vagy frissítése előtt. Vegye figyelembe, hogy a függő erőforrások, például a névtelen összetevők ellenőrzése nem lesz kihagyva. Alapértelmezés szerint Hamis.

Válaszok

Létrehozott vagy frissített feladat.

Visszatérési típus

Job

Kivételek

Union

UserErrorException

ValidationException

Akkor aktiválódott, ha a feladat nem érvényesíthető sikeresen. A részletek a hibaüzenetben lesznek megadva.

AssetException

Akkor jelenik meg, ha a feladateszközök (pl. Adatok, Kód, Modell, Környezet) ellenőrzése nem sikerült. A részletek a hibaüzenetben lesznek megadva.

ModelException

Akkor van előállítva, ha a feladatmodell nem érvényesíthető sikeresen. A részletek a hibaüzenetben lesznek megadva.

JobException

Akkor aktiválódott, ha a Feladat objektum vagy attribútumok megfelelően lettek formázva. A részletek a hibaüzenetben lesznek megadva.

EmptyDirectoryError

Fel van emelve, ha a helyi elérési út egy üres könyvtárra mutat.

DockerEngineNotAvailableError

Akkor aktiválódik, ha a Docker-motor nem érhető el a helyi feladathoz.

Példák

Új feladat létrehozása, majd a számítás frissítése.

   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

Letölti egy feladat naplóit és kimenetét.

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

Paraméterek

name

str

Kötelező

Egy feladat neve.

download_path

Union[<xref:PathLike>, str]

A letöltési célhelyként használni kívánt helyi elérési út. Alapértelmezés szerint a "." értékre van adva.

output_name

Optional[str]

A letölteni kívánt kimenet neve. Alapértelmezés szerint Nincs.

all

bool

Megadja, hogy az összes naplót és elnevezett kimenetet le kell-e tölteni. Alapértelmezés szerint Hamis.

Kivételek

JobException

Akkor jön létre, ha a feladat még nincs terminálállapotban. A részletek a hibaüzenetben lesznek megadva.

MlException

Elő van állítva, ha a naplók és kimenetek nem tölthetők le sikeresen. A részletek a hibaüzenetben lesznek megadva.

Példák

A feladat összes naplójának és nevesített kimenetének letöltése a "job-1-logs" helyi könyvtárba.

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

get

Lekér egy feladaterőforrást.

get(name: str) -> Job

Paraméterek

name

str

Kötelező

A feladat neve.

Válaszok

A szolgáltatásból lekért feladatobjektum.

Visszatérési típus

Job

Kivételek

ResourceNotFoundError

Akkor kerül elő, ha nem található a megadott nevű feladat.

UserErrorException

Akkor jön létre, ha a névparaméter nem sztring.

Példák

Egy "iris-dataset-job-1" nevű feladat beolvasása.

   retrieved_job = ml_client.jobs.get(job_name)

list

Felsorolja a munkaterületen lévő feladatokat.

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

Paraméterek

parent_job_name

Optional[str]

Ha meg van adva, csak azokat a feladatokat adja vissza, amelyek a nevesített feladat gyermekei. Alapértelmezés szerint Nincs érték, amely a munkaterület összes feladatát felsorolja.

list_view_type

ListViewType

Az archivált feladatok belefoglalásának/kizárásának nézettípusa. Alapértelmezés szerint ~azure.mgt.machinelearningservices.models.ListViewType.ACTIVE_ONLY, az archivált feladatok kivételével.

Válaszok

Feladatobjektumok iterátorszerű példánya.

Visszatérési típus

ItemPaged[Job]

Kivételek

ResourceNotFoundError

Akkor kerül elő, ha nem található a megadott nevű feladat.

Példák

Az archivált feladatok listájának lekérése egy "iris-dataset-jobs" nevű szülőfeladatot tartalmazó munkaterületen.

   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

Archivált feladat visszaállítása.

restore(name: str) -> None

Paraméterek

name

str

Kötelező

A feladat neve.

Kivételek

ResourceNotFoundError

Akkor kerül elő, ha nem található a megadott nevű feladat.

Példák

Archivált feladat visszaállítása.

   ml_client.jobs.restore(name=job_name)

show_services

Lekéri a feladat csomópontjával társított szolgáltatásokat.

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

Paraméterek

name

str

Kötelező

A feladat neve.

node_index

int

Kötelező

A csomópont indexe (nulla alapú). Alapértelmezés szerint 0.

Válaszok

Az adott csomópont feladatához társított szolgáltatások.

Visszatérési típus

dict[str, ServiceInstance]

Kivételek

ResourceNotFoundError

Akkor kerül elő, ha nem található a megadott nevű feladat.

Példák

A feladat 1. csomópontjával társított szolgáltatások lekérése.

   job_services = ml_client.jobs.show_services(job_name)

stream

Streameli egy futó feladat naplóit.

stream(name: str) -> None

Paraméterek

name

str

Kötelező

A feladat neve.

Kivételek

ResourceNotFoundError

Akkor kerül elő, ha nem található a megadott nevű feladat.

Példák

Futó feladat streamelése.

   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

Megjegyzés

Ez egy kísérleti módszer, és bármikor változhat. További információ: https://aka.ms/azuremlexperimental.

Ellenőrzi a Feladat objektumot, mielőtt elküldené a szolgáltatást. Névtelen adategységek akkor hozhatók létre, ha beágyazott entitások vannak, például Összetevő, Környezet és Kód. Jelenleg csak a folyamatfeladatok támogatottak az ellenőrzéshez.

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

Paraméterek

job

Job

Kötelező

Az érvényesítendő feladatobjektum.

raise_on_failure

bool

Megadja, hogy az ellenőrzés sikertelenségével hibát kell-e okozni. Alapértelmezés szerint Hamis.

Válaszok

Az összes talált hibát tartalmazó ValidationResult objektum.

Visszatérési típus

ValidationResult

Kivételek

ResourceNotFoundError

Akkor kerül elő, ha nem található a megadott nevű feladat.

Példák

PipelineJob objektum ellenőrzése és a talált hibák nyomtatása.

   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)