JobOperations Clase

Inicia una instancia de JobOperations.

Esta clase no se debe crear una instancia directamente. En su lugar, use el atributo jobs de un objeto MLClient.

Herencia

azure.ai.ml._scope_dependent_operations._ScopeDependentOperations

JobOperations

Constructor

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

Parámetros

operation_scope

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

Requerido

Variables de ámbito para las clases de operaciones de un objeto MLClient.

operation_config

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

Requerido

Configuración común para las clases de operaciones de un objeto MLClient.

service_client_02_2023_preview

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

Requerido

Cliente de servicio para permitir que los usuarios finales funcionen en los recursos del área de trabajo de Azure Machine Learning.

all_operations

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

Requerido

Todas las clases de operaciones de un objeto MLClient.

credential

TokenCredential

Requerido

Credencial que se va a usar para la autenticación.

Métodos

archive	Archiva un trabajo.
begin_cancel	Cancela un trabajo.
create_or_update	Crea o actualiza un trabajo. Si se definen entidades como Entorno o Código insertadas, se crearán junto con el trabajo.
download	Descarga los registros y la salida de un trabajo.
get	Obtiene un recurso de trabajo.
list	Enumera los trabajos del área de trabajo.
restore	Restaura un trabajo archivado.
show_services	Obtiene los servicios asociados con el nodo de un trabajo.
stream	Transmite los registros de un trabajo en ejecución.
validate	Nota Se trata de un método experimental y puede cambiar en cualquier momento. Consulte https://aka.ms/azuremlexperimental para más información. Valida un objeto Job antes de enviarlo al servicio. Se pueden crear recursos anónimos si hay entidades definidas insertadas como Componente, Entorno y Código. Actualmente solo se admiten trabajos de canalización para la validación.

archive

Archiva un trabajo.

archive(name: str) -> None

Parámetros

name

str

Requerido

Nombre del trabajo.

Excepciones

ResourceNotFoundError

Se genera si no se puede encontrar ningún trabajo con el nombre especificado.

Ejemplos

Archivado de un trabajo.

   ml_client.jobs.archive(name=job_name)

begin_cancel

Cancela un trabajo.

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

Parámetros

name

str

Requerido

Nombre del trabajo.

Devoluciones

Un sondeo para realizar un seguimiento del estado de la operación.

Tipo de valor devuelto

LROPoller[None]

Excepciones

ResourceNotFoundError

Se genera si no se puede encontrar ningún trabajo con el nombre especificado.

create_or_update

Crea o actualiza un trabajo. Si se definen entidades como Entorno o Código insertadas, se crearán junto con el trabajo.

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

Parámetros

job

Job

Requerido

Objeto de trabajo.

description

Optional[str]

Descripción del trabajo.

compute

Optional[str]

Destino de proceso para el trabajo.

tags

Optional[dict]

Etiquetas del trabajo.

experiment_name

Optional[str]

Nombre del experimento en el que se creará el trabajo. Si se proporciona None, el trabajo se creará en el experimento "Default".

skip_validation

bool

Especifica si se omitirá la validación antes de crear o actualizar el trabajo. Tenga en cuenta que no se omitirá la validación de recursos dependientes, como un componente anónimo. El valor predeterminado es False.

Devoluciones

Trabajo creado o actualizado.

Tipo de valor devuelto

Job

Excepciones

Union

UserErrorException

ValidationException

Se genera si el trabajo no se puede validar correctamente. Los detalles se proporcionarán en el mensaje de error.

AssetException

Se genera si los recursos de trabajo (por ejemplo, Datos, Código, Modelo, Entorno) no se pueden validar correctamente. Los detalles se proporcionarán en el mensaje de error.

ModelException

Se genera si el modelo de trabajo no se puede validar correctamente. Los detalles se proporcionarán en el mensaje de error.

JobException

Se genera si el objeto Job o los atributos tienen el formato correcto. Los detalles se proporcionarán en el mensaje de error.

EmptyDirectoryError

Se genera si la ruta de acceso local proporcionada apunta a un directorio vacío.

DockerEngineNotAvailableError

Se genera si el motor de Docker no está disponible para el trabajo local.

Ejemplos

Crear un nuevo trabajo y, a continuación, actualizar su proceso.

   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

Descarga los registros y la salida de un trabajo.

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

Parámetros

name

str

Requerido

El nombre de un trabajo.

download_path

Union[<xref:PathLike>, str]

Ruta de acceso local que se va a usar como destino de descarga. El valor predeterminado es ".".

output_name

Optional[str]

Nombre de la salida que se va a descargar. El valor predeterminado es None.

all

bool

Especifica si se deben descargar todos los registros y salidas con nombre. El valor predeterminado es False.

Excepciones

JobException

Se genera si job todavía no está en un estado terminal. Los detalles se proporcionarán en el mensaje de error.

MlException

Se genera si los registros y salidas no se pueden descargar correctamente. Los detalles se proporcionarán en el mensaje de error.

Ejemplos

Descargar todos los registros y salidas con nombre del trabajo "job-1" en el directorio local "job-1-logs".

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

get

Obtiene un recurso de trabajo.

get(name: str) -> Job

Parámetros

name

str

Requerido

Nombre del trabajo.

Devoluciones

Objeto de trabajo recuperado del servicio.

Tipo de valor devuelto

Job

Excepciones

ResourceNotFoundError

Se genera si no se puede encontrar ningún trabajo con el nombre especificado.

UserErrorException

Se genera si el parámetro name no es una cadena.

Ejemplos

Recuperar un trabajo denominado "iris-dataset-job-1".

   retrieved_job = ml_client.jobs.get(job_name)

list

Enumera los trabajos del área de trabajo.

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

Parámetros

parent_job_name

Optional[str]

Cuando se proporciona, solo devuelve trabajos secundarios del trabajo con nombre. El valor predeterminado es Ninguno, enumerando todos los trabajos del área de trabajo.

list_view_type

ListViewType

Tipo de vista para incluir o excluir trabajos archivados. El valor predeterminado es ~azure.mgt.machinelearningservices.models.ListViewType.ACTIVE_ONLY, excepto los trabajos archivados.

Devoluciones

Una instancia de tipo iterador de objetos Job.

Tipo de valor devuelto

ItemPaged[Job]

Excepciones

ResourceNotFoundError

Se genera si no se puede encontrar ningún trabajo con el nombre especificado.

Ejemplos

Recuperar una lista de los trabajos archivados en un área de trabajo con el trabajo primario denominado "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

Restaura un trabajo archivado.

restore(name: str) -> None

Parámetros

name

str

Requerido

Nombre del trabajo.

Excepciones

ResourceNotFoundError

Se genera si no se puede encontrar ningún trabajo con el nombre especificado.

Ejemplos

Restaurar un trabajo archivado.

   ml_client.jobs.restore(name=job_name)

show_services

Obtiene los servicios asociados con el nodo de un trabajo.

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

Parámetros

name

str

Requerido

Nombre del trabajo.

node_index

int

Requerido

Índice del nodo (basado en cero). El valor predeterminado es 0.

Devoluciones

Servicios asociados al trabajo para el nodo especificado.

Tipo de valor devuelto

dict[str, ServiceInstance]

Excepciones

ResourceNotFoundError

Se genera si no se puede encontrar ningún trabajo con el nombre especificado.

Ejemplos

Recuperar los servicios asociados con el nodo 1.º de un trabajo.

   job_services = ml_client.jobs.show_services(job_name)

stream

Transmite los registros de un trabajo en ejecución.

stream(name: str) -> None

Parámetros

name

str

Requerido

Nombre del trabajo.

Excepciones

ResourceNotFoundError

Se genera si no se puede encontrar ningún trabajo con el nombre especificado.

Ejemplos

Streaming de un trabajo en ejecución.

   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

Se trata de un método experimental y puede cambiar en cualquier momento. Consulte https://aka.ms/azuremlexperimental para más información.

Valida un objeto Job antes de enviarlo al servicio. Se pueden crear recursos anónimos si hay entidades definidas insertadas como Componente, Entorno y Código. Actualmente solo se admiten trabajos de canalización para la validación.

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

Parámetros

job

Job

Requerido

Objeto de trabajo que se va a validar.

raise_on_failure

bool

Especifica si se debe generar un error si se produce un error en la validación. El valor predeterminado es False.

Devoluciones

Objeto ValidationResult que contiene todos los errores encontrados.

Tipo de valor devuelto

ValidationResult

Excepciones

ResourceNotFoundError

Se genera si no se puede encontrar ningún trabajo con el nombre especificado.

Ejemplos

Validar un objeto PipelineJob e imprimir los errores encontrados.

   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)