JobOperations Třída

Inicializuje instanci JobOperations.

Tato třída by neměla být vytvořena přímo. Místo toho použijte atribut jobs objektu MLClient.

Dědičnost

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)

Parametry

operation_scope

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

Vyžadováno

Proměnné oboru pro třídy operací objektu MLClient.

operation_config

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

Vyžadováno

Běžná konfigurace pro třídy operací objektu MLClient.

service_client_02_2023_preview

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

Vyžadováno

Klient služby, který koncovým uživatelům umožňuje pracovat s prostředky pracovního prostoru Azure Machine Learning.

all_operations

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

Vyžadováno

Všechny třídy operací objektu MLClient.

credential

TokenCredential

Vyžadováno

Přihlašovací údaje, které se mají použít pro ověřování.

Metody

archive	Archivuje úlohu.
begin_cancel	Zruší úlohu.
create_or_update	Vytvoří nebo aktualizuje úlohu. Pokud jsou vložené entity, jako je prostředí nebo kód, vytvoří se společně s úlohou.
download	Stáhne protokoly a výstup úlohy.
get	Získá prostředek úlohy.
list	Zobrazí seznam úloh v pracovním prostoru.
restore	Obnoví archivovanou úlohu.
show_services	Získá služby přidružené k uzlu úlohy.
stream	Streamuje protokoly spuštěné úlohy.
validate	Poznámka Jedná se o experimentální metodu, která se může kdykoli změnit. Další informace najdete tady: https://aka.ms/azuremlexperimental. Před odesláním do služby ověří objekt úlohy. Anonymní prostředky mohou být vytvořeny, pokud existují vložené definované entity, jako jsou komponenta, prostředí a kód. V současné době se pro ověřování podporují jenom úlohy kanálu.

archive

Archivuje úlohu.

archive(name: str) -> None

Parametry

name

str

Vyžadováno

Název úlohy.

Výjimky

ResourceNotFoundError

Vyvolána, pokud se nenajde žádná úloha se zadaným názvem.

Příklady

Archivace úlohy.

   ml_client.jobs.archive(name=job_name)

begin_cancel

Zruší úlohu.

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

Parametry

name

str

Vyžadováno

Název úlohy.

Návraty

Poller pro sledování stavu operace.

Návratový typ

LROPoller[None]

Výjimky

ResourceNotFoundError

Vyvolána, pokud se nenajde žádná úloha se zadaným názvem.

create_or_update

Vytvoří nebo aktualizuje úlohu. Pokud jsou vložené entity, jako je prostředí nebo kód, vytvoří se společně s úlohou.

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

Parametry

job

Job

Vyžadováno

Objekt úlohy.

description

Optional[str]

Popis úlohy.

compute

Optional[str]

Cíl výpočetních prostředků pro úlohu.

tags

Optional[dict]

Značky úlohy

experiment_name

Optional[str]

Název experimentu, ve které bude úloha vytvořena. Pokud je k dispozici žádný, vytvoří se úloha v experimentu Výchozí.

skip_validation

bool

Určuje, zda se má přeskočit ověření před vytvořením nebo aktualizací úlohy. Upozorňujeme, že ověřování závislých prostředků, jako je anonymní komponenta, se nepřeskočí. Výchozí hodnota je False.

Návraty

Vytvořená nebo aktualizovaná úloha

Návratový typ

Job

Výjimky

Union

UserErrorException

ValidationException

Vyvolána, pokud úlohu nelze úspěšně ověřit. Podrobnosti budou uvedeny v chybové zprávě.

AssetException

Vyvolána, pokud prostředky úlohy (např. data, kód, model, prostředí) nelze úspěšně ověřit. Podrobnosti budou uvedeny v chybové zprávě.

ModelException

Vyvolána, pokud model úlohy nelze úspěšně ověřit. Podrobnosti budou uvedeny v chybové zprávě.

JobException

Vyvolána, pokud je objekt úlohy nebo atributy správně naformátované. Podrobnosti budou uvedeny v chybové zprávě.

EmptyDirectoryError

Vyvoláno, pokud zadaná místní cesta odkazuje na prázdný adresář.

DockerEngineNotAvailableError

Vyvolána, pokud modul Dockeru není k dispozici pro místní úlohu.

Příklady

Vytvoření nové úlohy a následná aktualizace jejích výpočetních prostředků

   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

Stáhne protokoly a výstup úlohy.

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

Parametry

name

str

Vyžadováno

Název úlohy.

download_path

Union[<xref:PathLike>, str]

Místní cesta, která se má použít jako cíl stahování. Výchozí hodnota je "..

output_name

Optional[str]

Název výstupu ke stažení. Výchozí hodnota je Žádná.

all

bool

Určuje, jestli se mají stáhnout všechny protokoly a pojmenované výstupy. Výchozí hodnota je False.

Výjimky

JobException

Vyvolána, pokud úloha ještě není v terminálovém stavu. Podrobnosti budou uvedeny v chybové zprávě.

MlException

Vyvolána, pokud protokoly a výstupy nelze úspěšně stáhnout. Podrobnosti budou uvedeny v chybové zprávě.

Příklady

Stahují se všechny protokoly a pojmenované výstupy úlohy job-1 do místního adresáře job-1-logs.

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

get

Získá prostředek úlohy.

get(name: str) -> Job

Parametry

name

str

Vyžadováno

Název úlohy.

Návraty

Objekt úlohy načtený ze služby.

Návratový typ

Job

Výjimky

ResourceNotFoundError

Vyvolána, pokud se nenajde žádná úloha se zadaným názvem.

UserErrorException

Vyvolána, pokud parametr name není řetězec.

Příklady

Načítání úlohy s názvem iris-dataset-job-1

   retrieved_job = ml_client.jobs.get(job_name)

list

Zobrazí seznam úloh v pracovním prostoru.

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

Parametry

parent_job_name

Optional[str]

Pokud je k dispozici, vrátí pouze úlohy, které jsou podřízené pojmenované úloze. Ve výchozím nastavení se zobrazí seznam všech úloh v pracovním prostoru.

list_view_type

ListViewType

Typ zobrazení pro zahrnutí nebo vyloučení archivovaných úloh. Výchozí hodnota je ~azure.mgt.machinelearningservices.models.ListViewType.ACTIVE_ONLY s výjimkou archivovaných úloh.

Návraty

Instance objektu Job podobného iterátoru.

Návratový typ

ItemPaged[Job]

Výjimky

ResourceNotFoundError

Vyvolána, pokud se nenajde žádná úloha se zadaným názvem.

Příklady

Načtení seznamu archivovaných úloh v pracovním prostoru s nadřazenou úlohou s názvem 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

Obnoví archivovanou úlohu.

restore(name: str) -> None

Parametry

name

str

Vyžadováno

Název úlohy.

Výjimky

ResourceNotFoundError

Vyvolána, pokud se nenajde žádná úloha se zadaným názvem.

Příklady

Obnovení archivované úlohy.

   ml_client.jobs.restore(name=job_name)

show_services

Získá služby přidružené k uzlu úlohy.

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

Parametry

name

str

Vyžadováno

Název úlohy.

node_index

int

Vyžadováno

Index uzlu (založený na nule). Výchozí hodnota je 0.

Návraty

Služby přidružené k úloze pro daný uzel.

Návratový typ

dict[str, ServiceInstance]

Výjimky

ResourceNotFoundError

Vyvolána, pokud se nenajde žádná úloha se zadaným názvem.

Příklady

Načítání služeb přidružených k 1. uzlu úlohy

   job_services = ml_client.jobs.show_services(job_name)

stream

Streamuje protokoly spuštěné úlohy.

stream(name: str) -> None

Parametry

name

str

Vyžadováno

Název úlohy.

Výjimky

ResourceNotFoundError

Vyvolána, pokud se nenajde žádná úloha se zadaným názvem.

Příklady

Streamování spuštěné úlohy

   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

Poznámka

Jedná se o experimentální metodu, která se může kdykoli změnit. Další informace najdete tady: https://aka.ms/azuremlexperimental.

Před odesláním do služby ověří objekt úlohy. Anonymní prostředky mohou být vytvořeny, pokud existují vložené definované entity, jako jsou komponenta, prostředí a kód. V současné době se pro ověřování podporují jenom úlohy kanálu.

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

Parametry

job

Job

Vyžadováno

Objekt úlohy, který se má ověřit.

raise_on_failure

bool

Určuje, jestli má být vyvolána chyba, pokud se ověření nezdaří. Výchozí hodnota je False.

Návraty

Objekt ValidationResult obsahující všechny nalezené chyby.

Návratový typ

ValidationResult

Výjimky

ResourceNotFoundError

Vyvolána, pokud se nenajde žádná úloha se zadaným názvem.

Příklady

Ověření objektu PipelineJob a tisk nalezených chyb

   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)