JobOperations Classe

Avvia un'istanza di JobOperations

Questa classe non deve essere creata direttamente. Usare invece l'attributo processi di un oggetto MLClient.

Ereditarietà

azure.ai.ml._scope_dependent_operations._ScopeDependentOperations

JobOperations

Costruttore

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

Parametri

operation_scope

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

Necessario

Variabili di ambito per le classi di operazioni di un oggetto MLClient.

operation_config

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

Necessario

Configurazione comune per le classi di operazioni di un oggetto MLClient.

service_client_02_2023_preview

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

Necessario

Client del servizio per consentire agli utenti finali di operare sulle risorse dell'area di lavoro di Azure Machine Learning.

all_operations

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

Necessario

Tutte le classi di operazioni di un oggetto MLClient.

credential

TokenCredential

Necessario

Credenziali da usare per l'autenticazione.

Metodi

archive	Archivia un lavoro.
begin_cancel	Annulla un processo.
create_or_update	Crea o aggiorna un processo. Se le entità come Ambiente o Codice sono definite inline, verranno create insieme al processo.
download	Scarica i log e l'output di un processo.
get	Ottiene una risorsa del processo.
list	Elenca i processi nell'area di lavoro.
restore	Ripristina un processo archiviato.
show_services	Ottiene i servizi associati al nodo di un processo.
stream	Trasmette i log di un processo in esecuzione.
validate	Nota Si tratta di un metodo sperimentale e può cambiare in qualsiasi momento. Per altre informazioni, vedere https://aka.ms/azuremlexperimental. Convalida un oggetto Job prima di inviare al servizio. Gli asset anonimi possono essere creati se sono presenti entità definite inline, ad esempio Component, Environment e Code. Attualmente sono supportati solo i processi della pipeline per la convalida.

archive

Archivia un lavoro.

archive(name: str) -> None

Parametri

name

str

Necessario

Nome del processo.

Eccezioni

ResourceNotFoundError

Generato se non è possibile trovare alcun processo con il nome specificato.

Esempio

Archiviazione di un processo.

   ml_client.jobs.archive(name=job_name)

begin_cancel

Annulla un processo.

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

Parametri

name

str

Necessario

Nome del processo.

Restituisce

Un poller per tenere traccia dello stato dell'operazione.

Tipo restituito

LROPoller[None]

Eccezioni

ResourceNotFoundError

Generato se non è possibile trovare alcun processo con il nome specificato.

create_or_update

Crea o aggiorna un processo. Se le entità come Ambiente o Codice sono definite inline, verranno create insieme al processo.

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

Parametri

job

Job

Necessario

Oggetto processo.

description

Optional[str]

Descrizione del processo.

compute

Optional[str]

Destinazione di calcolo per il processo.

tags

Optional[dict]

Tag per il processo.

experiment_name

Optional[str]

Il nome dell'esperimento in cui verrà creato il processo. Se None viene specificato, il processo verrà creato in 'Default'.

skip_validation

bool

Specifica se ignorare la convalida prima di creare o aggiornare il processo. Si noti che la convalida per le risorse dipendenti, ad esempio un componente anonimo, non verrà ignorata. Il valore predefinito è False.

Restituisce

Processo creato o aggiornato.

Tipo restituito

Job

Eccezioni

Union

UserErrorException

ValidationException

Generato se il processo non può essere convalidato correttamente. I dettagli verranno forniti nel messaggio di errore.

AssetException

Generato se gli asset del processo (ad esempio dati, codice, modello, ambiente) non possono essere convalidati correttamente. I dettagli verranno forniti nel messaggio di errore.

ModelException

Generato se il modello di processo non può essere convalidato correttamente. I dettagli verranno forniti nel messaggio di errore.

JobException

Generato se l'oggetto Job o gli attributi sono formattati correttamente. I dettagli verranno forniti nel messaggio di errore.

EmptyDirectoryError

Generato se il percorso locale ha fornito punti a una directory vuota.

DockerEngineNotAvailableError

Generato se il motore Docker non è disponibile per il processo locale.

Esempio

Creazione di un nuovo processo e quindi aggiornamento del relativo calcolo.

   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

Scarica i log e l'output di un processo.

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

Parametri

name

str

Necessario

Nome di un processo.

download_path

Union[<xref:PathLike>, str]

Percorso locale da usare come destinazione di download. Impostazione predefinita su ".".

output_name

Optional[str]

Nome dell'output da scaricare. Il valore predefinito è Nessuna.

all

bool

Specifica se tutti i log e gli output denominati devono essere scaricati. Il valore predefinito è False.

Eccezioni

JobException

Generato se il processo non è ancora in uno stato del terminale. I dettagli verranno forniti nel messaggio di errore.

MlException

Generato se i log e gli output non possono essere scaricati correttamente. I dettagli verranno forniti nel messaggio di errore.

Esempio

Scaricare tutti i log e gli output denominati del processo "job-1" nella directory locale "job-1-logs".

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

get

Ottiene una risorsa del processo.

get(name: str) -> Job

Parametri

name

str

Necessario

Nome del processo.

Restituisce

Oggetto processo recuperato dal servizio.

Tipo restituito

Job

Eccezioni

ResourceNotFoundError

Generato se non è possibile trovare alcun processo con il nome specificato.

UserErrorException

Generato se il parametro name non è una stringa.

Esempio

Recupero di un processo denominato "iris-dataset-job-1".

   retrieved_job = ml_client.jobs.get(job_name)

list

Elenca i processi nell'area di lavoro.

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

Parametri

parent_job_name

Optional[str]

Se specificato, restituisce solo processi figlio del processo denominato. Per impostazione predefinita none, elencare tutti i processi nell'area di lavoro.

list_view_type

ListViewType

Tipo di visualizzazione per l'inclusione/esclusione di processi archiviati. Il valore predefinito è ~azure.mgt.machinelearningservices.models.ListViewType.ACTIVE_ONLY, escluso i processi archiviati.

Restituisce

Istanza simile a iteratore degli oggetti Job.

Tipo restituito

ItemPaged[Job]

Eccezioni

ResourceNotFoundError

Generato se non è possibile trovare alcun processo con il nome specificato.

Esempio

Recupero di un elenco dei processi archiviati in un'area di lavoro con processo padre denominato "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

Ripristina un processo archiviato.

restore(name: str) -> None

Parametri

name

str

Necessario

Nome del processo.

Eccezioni

ResourceNotFoundError

Generato se non è possibile trovare alcun processo con il nome specificato.

Esempio

Ripristino di un processo archiviato.

   ml_client.jobs.restore(name=job_name)

show_services

Ottiene i servizi associati al nodo di un processo.

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

Parametri

name

str

Necessario

Nome del processo.

node_index

int

Necessario

Indice del nodo (basato su zero). Il valore predefinito è 0.

Restituisce

I servizi associati al processo per il nodo specificato.

Tipo restituito

dict[str, ServiceInstance]

Eccezioni

ResourceNotFoundError

Generato se non è possibile trovare alcun processo con il nome specificato.

Esempio

Recupero dei servizi associati al nodo 1° del processo.

   job_services = ml_client.jobs.show_services(job_name)

stream

Trasmette i log di un processo in esecuzione.

stream(name: str) -> None

Parametri

name

str

Necessario

Nome del processo.

Eccezioni

ResourceNotFoundError

Generato se non è possibile trovare alcun processo con il nome specificato.

Esempio

Streaming di un processo in esecuzione.

   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

Nota

Si tratta di un metodo sperimentale e può cambiare in qualsiasi momento. Per altre informazioni, vedere https://aka.ms/azuremlexperimental.

Convalida un oggetto Job prima di inviare al servizio. Gli asset anonimi possono essere creati se sono presenti entità definite inline, ad esempio Component, Environment e Code. Attualmente sono supportati solo i processi della pipeline per la convalida.

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

Parametri

job

Job

Necessario

Oggetto processo da convalidare.

raise_on_failure

bool

Specifica se deve essere generato un errore se la convalida ha esito negativo. Il valore predefinito è False.

Restituisce

Oggetto ValidationResult contenente tutti gli errori trovati.

Tipo restituito

ValidationResult

Eccezioni

ResourceNotFoundError

Generato se non è possibile trovare alcun processo con il nome specificato.

Esempio

Convalida di un oggetto PipelineJob e stampando gli errori trovati.

   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)