JobOperations Classe

Lance une instance de JobOperations

Cette classe ne doit pas être instanciée directement. Utilisez plutôt l’attribut jobs d’un objet MLClient.

Héritage

azure.ai.ml._scope_dependent_operations._ScopeDependentOperations

JobOperations

Constructeur

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

Paramètres

operation_scope

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

Obligatoire

Variables d’étendue pour les classes d’opérations d’un objet MLClient.

operation_config

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

Obligatoire

Configuration courante pour les classes d’opérations d’un objet MLClient.

service_client_02_2023_preview

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

Obligatoire

Client de service pour permettre aux utilisateurs finaux d’utiliser des ressources d’espace de travail Azure Machine Learning.

all_operations

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

Obligatoire

Toutes les classes d’opérations d’un objet MLClient.

credential

TokenCredential

Obligatoire

Informations d’identification à utiliser pour l’authentification.

Méthodes

archive	Archive un travail.
begin_cancel	Annule un travail.
create_or_update	Crée ou met à jour un travail. Si des entités telles que Environment ou Code sont définies en ligne, elles sont créées avec le travail.
download	Télécharge les journaux et la sortie d’un travail.
get	Obtient une ressource de travail.
list	Répertorie les travaux dans l’espace de travail.
restore	Restaure un travail archivé.
show_services	Obtient les services associés au nœud d’un travail.
stream	Diffuse en continu les journaux d’un travail en cours d’exécution.
validate	Notes Il s’agit d’une méthode expérimentale qui peut changer à tout moment. Pour plus d’informations, consultez https://aka.ms/azuremlexperimental. Valide un objet Job avant de l’envoyer au service. Des ressources anonymes peuvent être créées s’il existe des entités définies inline telles que Component, Environment et Code. Seuls les travaux de pipeline sont actuellement pris en charge pour la validation.

archive

Archive un travail.

archive(name: str) -> None

Paramètres

name

str

Obligatoire

Nom du travail.

Exceptions

ResourceNotFoundError

Déclenché si aucun travail portant le nom donné n’est trouvé.

Exemples

Archivage d’un travail.

   ml_client.jobs.archive(name=job_name)

begin_cancel

Annule un travail.

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

Paramètres

name

str

Obligatoire

Nom du travail.

Retours

Un polleur pour suivre l’opération status.

Type de retour

LROPoller[None]

Exceptions

ResourceNotFoundError

Déclenché si aucun travail portant le nom donné n’est trouvé.

create_or_update

Crée ou met à jour un travail. Si des entités telles que Environment ou Code sont définies en ligne, elles sont créées avec le travail.

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ètres

job

Job

Obligatoire

Objet de travail.

description

Optional[str]

Description du travail.

compute

Optional[str]

Cible de calcul pour le travail.

tags

Optional[dict]

Balises du travail.

experiment_name

Optional[str]

Nom de l’expérience sous laquelle le travail sera créé. Si Aucun est fourni, le travail est créé sous l’expérience « Par défaut ».

skip_validation

bool

Spécifie si la validation doit être ignorée avant de créer ou de mettre à jour le travail. Notez que la validation des ressources dépendantes telles qu’un composant anonyme ne sera pas ignorée. Valeur par défaut False.

Retours

Travail créé ou mis à jour.

Type de retour

Job

Exceptions

Union

UserErrorException

ValidationException

Déclenché si le travail ne peut pas être validé avec succès. Les détails seront fournis dans le message d’erreur.

AssetException

Déclenché si les ressources de travail (par exemple, données, code, modèle, environnement) ne peuvent pas être validées correctement. Les détails seront fournis dans le message d’erreur.

ModelException

Déclenché si le modèle de travail ne peut pas être validé avec succès. Les détails seront fournis dans le message d’erreur.

JobException

Déclenché si l’objet ou les attributs job ont été correctement mis en forme. Les détails seront fournis dans le message d’erreur.

EmptyDirectoryError

Déclenché si le chemin d’accès local fourni pointe vers un répertoire vide.

DockerEngineNotAvailableError

Déclenché si le moteur Docker n’est pas disponible pour le travail local.

Exemples

Création d’un travail, puis mise à jour de son calcul.

   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

Télécharge les journaux et la sortie d’un travail.

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

Paramètres

name

str

Obligatoire

Nom d'un travail.

download_path

Union[<xref:PathLike>, str]

Chemin d’accès local à utiliser comme destination de téléchargement. La valeur par défaut est « ».

output_name

Optional[str]

Nom de la sortie à télécharger. La valeur par défaut est None.

all

bool

Spécifie si tous les journaux et les sorties nommées doivent être téléchargés. Valeur par défaut False.

Exceptions

JobException

Déclenché si Le travail n’est pas encore dans un état terminal. Les détails seront fournis dans le message d’erreur.

MlException

Déclenché si les journaux et les sorties ne peuvent pas être téléchargés avec succès. Les détails seront fournis dans le message d’erreur.

Exemples

Téléchargement de tous les journaux et des sorties nommées du travail « job-1 » dans le répertoire local « job-1-logs ».

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

get

Obtient une ressource de travail.

get(name: str) -> Job

Paramètres

name

str

Obligatoire

Nom du travail.

Retours

Objet de travail récupéré à partir du service.

Type de retour

Job

Exceptions

ResourceNotFoundError

Déclenché si aucun travail portant le nom donné n’est trouvé.

UserErrorException

Déclenché si le paramètre name n’est pas une chaîne.

Exemples

Récupération d’un travail nommé « iris-dataset-job-1 ».

   retrieved_job = ml_client.jobs.get(job_name)

list

Répertorie les travaux dans l’espace de travail.

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

Paramètres

parent_job_name

Optional[str]

Lorsqu’il est fourni, retourne uniquement les travaux qui sont des enfants du travail nommé. La valeur par défaut est None, répertoriant tous les travaux de l’espace de travail.

list_view_type

ListViewType

Type d’affichage pour inclure/exclure des travaux archivés. La valeur par défaut est ~azure.mgt.machinelearningservices.models.ListViewType.ACTIVE_ONLY, à l’exclusion des travaux archivés.

Retours

Un instance de type itérateur d’objets Job.

Type de retour

ItemPaged[Job]

Exceptions

ResourceNotFoundError

Déclenché si aucun travail portant le nom donné n’est trouvé.

Exemples

Récupération d’une liste des travaux archivés dans un espace de travail avec un travail parent nommé « 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

Restaure un travail archivé.

restore(name: str) -> None

Paramètres

name

str

Obligatoire

Nom du travail.

Exceptions

ResourceNotFoundError

Déclenché si aucun travail portant le nom donné n’est trouvé.

Exemples

Restauration d’un travail archivé.

   ml_client.jobs.restore(name=job_name)

show_services

Obtient les services associés au nœud d’un travail.

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

Paramètres

name

str

Obligatoire

Nom du travail.

node_index

int

Obligatoire

Index du nœud (base zéro). La valeur par défaut est 0.

Retours

Services associés au travail pour le nœud donné.

Type de retour

dict[str, ServiceInstance]

Exceptions

ResourceNotFoundError

Déclenché si aucun travail portant le nom donné n’est trouvé.

Exemples

Récupération des services associés au premier nœud d’un travail.

   job_services = ml_client.jobs.show_services(job_name)

stream

Diffuse en continu les journaux d’un travail en cours d’exécution.

stream(name: str) -> None

Paramètres

name

str

Obligatoire

Nom du travail.

Exceptions

ResourceNotFoundError

Déclenché si aucun travail portant le nom donné n’est trouvé.

Exemples

Diffusion en continu d’un travail en cours d’exécution.

   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

Notes

Il s’agit d’une méthode expérimentale qui peut changer à tout moment. Pour plus d’informations, consultez https://aka.ms/azuremlexperimental.

Valide un objet Job avant de l’envoyer au service. Des ressources anonymes peuvent être créées s’il existe des entités définies inline telles que Component, Environment et Code. Seuls les travaux de pipeline sont actuellement pris en charge pour la validation.

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

Paramètres

job

Job

Obligatoire

Objet de travail à valider.

raise_on_failure

bool

Spécifie si une erreur doit être déclenchée en cas d’échec de la validation. Valeur par défaut False.

Retours

Objet ValidationResult contenant toutes les erreurs détectées.

Type de retour

ValidationResult

Exceptions

ResourceNotFoundError

Déclenché si aucun travail portant le nom donné n’est trouvé.

Exemples

Validation d’un objet PipelineJob et impression des erreurs trouvées.

   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)