JobOperations クラス

JobOperations のインスタンスを開始します

このクラスは直接インスタンス化しないでください。 代わりに、MLClient オブジェクトの jobs 属性を使用します。

継承

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	Note これは試験的なメソッドであり、いつでも変更される可能性があります。 詳細については、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]

ジョブが作成される実験の名前。 None を指定すると、実験 'Default' の下にジョブが作成されます。

skip_validation

bool

ジョブを作成または更新する前に検証をスキップするかどうかを指定します。 匿名コンポーネントなどの依存リソースの検証はスキップされないことに注意してください。 既定値は False です。

戻り値

ジョブを作成または更新しました。

の戻り値の型 :

Job

例外

Union

UserErrorException

ValidationException

Job が正常に検証できない場合に発生します。 詳細はエラー メッセージに表示されます。

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

Job がまだ終了状態でない場合に発生します。 詳細はエラー メッセージに表示されます。

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]

指定すると、名前付きジョブの子であるジョブのみが返されます。 既定値は None で、ワークスペース内のすべてのジョブが一覧表示されます。

list_view_type

ListViewType

アーカイブされたジョブを含める/除外するためのビューの種類。 アーカイブされたジョブを除き、既定値は ~azure.mgt.machinelearningservices.models.ListViewType.ACTIVE_ONLY です。

戻り値

Job オブジェクトの反復子に似たインスタンス。

の戻り値の型 :

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

指定された名前のジョブが見つからない場合に発生します。

例

ジョブの 1 番目のノードに関連付けられているサービスの取得。

   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

Note

これは試験的なメソッドであり、いつでも変更される可能性があります。 詳細については、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)