JobOperations 클래스

JobOperations의 instance 시작합니다.

이 클래스는 직접 인스턴스화해서는 안 됩니다. 대신 MLClient 개체의 작업 특성을 사용합니다.

상속

azure.ai.ml._scope_dependent_operations._ScopeDependentOperations

JobOperations

생성자

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

매개 변수

operation_scope

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

필수

MLClient 개체의 작업 클래스에 대한 범위 변수입니다.

operation_config

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

필수

MLClient 개체의 작업 클래스에 대한 일반적인 구성입니다.

service_client_02_2023_preview

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

필수

최종 사용자가 Azure Machine Learning 작업 영역 리소스에서 작동할 수 있도록 하는 서비스 클라이언트입니다.

all_operations

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

필수

MLClient 개체의 모든 작업 클래스입니다.

credential

TokenCredential

필수

인증에 사용할 자격 증명입니다.

메서드

archive	작업을 보관합니다.
begin_cancel	작업을 취소합니다.
create_or_update	작업을 만들거나 업데이트합니다. 환경 또는 코드와 같은 엔터티가 인라인으로 정의되면 작업과 함께 만들어집니다.
download	작업의 로그 및 출력을 다운로드합니다.
get	작업 리소스를 가져옵니다.
list	작업 영역의 작업을 나열합니다.
restore	보관된 작업을 복원합니다.
show_services	작업의 노드와 연결된 서비스를 가져옵니다.
stream	실행 중인 작업의 로그를 스트리밍합니다.
validate	참고 이는 실험적인 메서드이며 언제든지 변경될 수도 있습니다. 자세한 내용은 https://aka.ms/azuremlexperimental을 참조하세요. 서비스에 제출하기 전에 Job 개체의 유효성을 검사합니다. 구성 요소, 환경 및 코드와 같은 인라인 정의 엔터티가 있는 경우 익명 자산을 만들 수 있습니다. 현재 유효성 검사에는 파이프라인 작업만 지원됩니다.

archive

작업을 보관합니다.

archive(name: str) -> None

매개 변수

name

str

필수

작업의 이름입니다.

예외

ResourceNotFoundError

지정된 이름의 작업을 찾을 수 없는 경우 발생합니다.

예제

작업 보관.

   ml_client.jobs.archive(name=job_name)

begin_cancel

작업을 취소합니다.

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

매개 변수

name

str

필수

작업의 이름입니다.

반환

작업 상태 추적하는 폴러입니다.

반환 형식

LROPoller[None]

예외

ResourceNotFoundError

지정된 이름의 작업을 찾을 수 없는 경우 발생합니다.

create_or_update

작업을 만들거나 업데이트합니다. 환경 또는 코드와 같은 엔터티가 인라인으로 정의되면 작업과 함께 만들어집니다.

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

매개 변수

job

Job

필수

작업 개체입니다.

description

Optional[str]

작업 설명입니다.

compute

Optional[str]

작업의 컴퓨팅 대상입니다.

tags

Optional[dict]

작업에 대한 태그입니다.

experiment_name

Optional[str]

작업이 만들어질 실험의 이름입니다. 없음이 제공되면 '기본값' 실험에서 작업이 만들어집니다.

skip_validation

bool

작업을 만들거나 업데이트하기 전에 유효성 검사를 건너뛸지 여부를 지정합니다. 익명 구성 요소와 같은 종속 리소스에 대한 유효성 검사는 건너뛰지 않습니다. 기본값은 False입니다.

반환

작업을 만들거나 업데이트했습니다.

반환 형식

Job

예외

Union

UserErrorException

ValidationException

작업의 유효성을 성공적으로 검사할 수 없는 경우 발생합니다. 자세한 내용은 오류 메시지에 제공됩니다.

AssetException

작업 자산(예: 데이터, 코드, 모델, 환경)의 유효성을 성공적으로 검사할 수 없는 경우 발생합니다. 자세한 내용은 오류 메시지에 제공됩니다.

ModelException

작업 모델의 유효성을 성공적으로 검사할 수 없는 경우 발생합니다. 자세한 내용은 오류 메시지에 제공됩니다.

JobException

Job 개체 또는 특성의 형식이 올바르게 지정되면 발생합니다. 자세한 내용은 오류 메시지에 제공됩니다.

EmptyDirectoryError

로컬 경로 제공이 빈 디렉터리를 가리키는 경우 발생합니다.

DockerEngineNotAvailableError

로컬 작업에 Docker 엔진을 사용할 수 없는 경우 발생합니다.

예제

새 작업을 만든 다음 컴퓨팅을 업데이트합니다.

   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

작업의 로그 및 출력을 다운로드합니다.

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

매개 변수

name

str

필수

작업의 이름입니다.

download_path

Union[<xref:PathLike>, str]

다운로드 대상으로 사용할 로컬 경로입니다. 기본값은 "."입니다.

output_name

Optional[str]

다운로드할 출력의 이름입니다. 기본값은 None입니다.

all

bool

모든 로그 및 명명된 출력을 다운로드해야 하는지를 지정합니다. 기본값은 False입니다.

예외

JobException

작업이 아직 터미널 상태가 아닌 경우 발생합니다. 자세한 내용은 오류 메시지에 제공됩니다.

MlException

로그 및 출력을 성공적으로 다운로드할 수 없는 경우 발생합니다. 자세한 내용은 오류 메시지에 제공됩니다.

예제

작업 "job-1"의 모든 로그 및 명명된 출력을 로컬 디렉터리 "job-1-logs"로 다운로드합니다.

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

get

작업 리소스를 가져옵니다.

get(name: str) -> Job

매개 변수

name

str

필수

작업의 이름입니다.

반환

서비스에서 검색된 작업 개체입니다.

반환 형식

Job

예외

ResourceNotFoundError

지정된 이름의 작업을 찾을 수 없는 경우 발생합니다.

UserErrorException

name 매개 변수가 문자열이 아닌 경우 발생합니다.

예제

"iris-dataset-job-1"이라는 작업을 검색합니다.

   retrieved_job = ml_client.jobs.get(job_name)

list

작업 영역의 작업을 나열합니다.

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

매개 변수

parent_job_name

Optional[str]

제공된 경우 명명된 작업의 자식인 작업만 반환합니다. 기본값은 없음으로 설정되며 작업 영역의 모든 작업을 나열합니다.

list_view_type

ListViewType

보관된 작업을 포함/제외하기 위한 보기 형식입니다. 보관된 작업을 제외한 기본값은 ~azure.mgt.machinelearningservices.models.ListViewType.ACTIVE_ONLY.

반환

Job 개체의 반복기와 유사한 instance.

반환 형식

ItemPaged[Job]

예외

ResourceNotFoundError

지정된 이름의 작업을 찾을 수 없는 경우 발생합니다.

예제

"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

보관된 작업을 복원합니다.

restore(name: str) -> None

매개 변수

name

str

필수

작업의 이름입니다.

예외

ResourceNotFoundError

지정된 이름의 작업을 찾을 수 없는 경우 발생합니다.

예제

보관된 작업 복원

   ml_client.jobs.restore(name=job_name)

show_services

작업의 노드와 연결된 서비스를 가져옵니다.

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

매개 변수

name

str

필수

작업의 이름입니다.

node_index

int

필수

노드의 인덱스(0부터 시작)입니다. 기본값은 0입니다.

반환

지정된 노드의 작업과 연결된 서비스입니다.

반환 형식

dict[str, ServiceInstance]

예외

ResourceNotFoundError

지정된 이름의 작업을 찾을 수 없는 경우 발생합니다.

예제

작업의 첫 번째 노드와 연결된 서비스를 검색합니다.

   job_services = ml_client.jobs.show_services(job_name)

stream

실행 중인 작업의 로그를 스트리밍합니다.

stream(name: str) -> None

매개 변수

name

str

필수

작업의 이름입니다.

예외

ResourceNotFoundError

지정된 이름의 작업을 찾을 수 없는 경우 발생합니다.

예제

실행 중인 작업 스트리밍.

   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

참고

이는 실험적인 메서드이며 언제든지 변경될 수도 있습니다. 자세한 내용은 https://aka.ms/azuremlexperimental을 참조하세요.

서비스에 제출하기 전에 Job 개체의 유효성을 검사합니다. 구성 요소, 환경 및 코드와 같은 인라인 정의 엔터티가 있는 경우 익명 자산을 만들 수 있습니다. 현재 유효성 검사에는 파이프라인 작업만 지원됩니다.

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

매개 변수

job

Job

필수

유효성을 검사할 작업 개체입니다.

raise_on_failure

bool

유효성 검사에 실패할 경우 오류를 발생시켜야 하는지를 지정합니다. 기본값은 False입니다.

반환

찾은 모든 오류를 포함하는 ValidationResult 개체입니다.

반환 형식

ValidationResult

예외

ResourceNotFoundError

지정된 이름의 작업을 찾을 수 없는 경우 발생합니다.

예제

PipelineJob 개체의 유효성을 검사하고 찾은 오류를 인쇄합니다.

   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)