JobOperations クラス
JobOperations のインスタンスを開始します
このクラスは直接インスタンス化しないでください。 代わりに、MLClient オブジェクトの jobs 属性を使用します。
- 継承
-
azure.ai.ml._scope_dependent_operations._ScopeDependentOperationsJobOperations
コンストラクター
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 オブジェクトのすべての操作クラス。
メソッド
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
パラメーター
例外
指定された名前のジョブが見つからない場合に発生します。
例
ジョブのアーカイブ。
ml_client.jobs.archive(name=job_name)
begin_cancel
ジョブを取り消します。
begin_cancel(name: str, **kwargs) -> LROPoller[None]
パラメーター
戻り値
操作の状態を追跡するポーリングャー。
の戻り値の型 :
例外
指定された名前のジョブが見つからない場合に発生します。
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
パラメーター
- skip_validation
- bool
ジョブを作成または更新する前に検証をスキップするかどうかを指定します。 匿名コンポーネントなどの依存リソースの検証はスキップされないことに注意してください。 既定値は False です。
戻り値
ジョブを作成または更新しました。
の戻り値の型 :
例外
Job が正常に検証できない場合に発生します。 詳細はエラー メッセージに表示されます。
ジョブ資産 (データ、コード、モデル、環境など) が正常に検証できない場合に発生します。 詳細はエラー メッセージに表示されます。
ジョブ モデルを正常に検証できない場合に発生します。 詳細はエラー メッセージに表示されます。
Job オブジェクトまたは属性の書式が正しい場合に発生します。 詳細はエラー メッセージに表示されます。
指定されたローカル パスが空のディレクトリを指している場合に発生します。
ローカル ジョブで 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
パラメーター
- all
- bool
すべてのログと名前付き出力をダウンロードするかどうかを指定します。 既定値は False です。
例外
Job がまだ終了状態でない場合に発生します。 詳細はエラー メッセージに表示されます。
ログと出力を正常にダウンロードできない場合に発生します。 詳細はエラー メッセージに表示されます。
例
ジョブ "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 パラメーターが文字列でない場合に発生します。
例
"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]
パラメーター
- list_view_type
- ListViewType
アーカイブされたジョブを含める/除外するためのビューの種類。 アーカイブされたジョブを除き、既定値は ~azure.mgt.machinelearningservices.models.ListViewType.ACTIVE_ONLY です。
戻り値
Job オブジェクトの反復子に似たインスタンス。
の戻り値の型 :
例外
指定された名前のジョブが見つからない場合に発生します。
例
"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
パラメーター
例外
指定された名前のジョブが見つからない場合に発生します。
例
アーカイブされたジョブの復元。
ml_client.jobs.restore(name=job_name)
show_services
ジョブのノードに関連付けられているサービスを取得します。
show_services(name: str, node_index: int = 0) -> Dict[str, ServiceInstance]
パラメーター
戻り値
指定されたノードのジョブに関連付けられているサービス。
の戻り値の型 :
例外
指定された名前のジョブが見つからない場合に発生します。
例
ジョブの 1 番目のノードに関連付けられているサービスの取得。
job_services = ml_client.jobs.show_services(job_name)
stream
実行中のジョブのログをストリーミングします。
stream(name: str) -> None
パラメーター
例外
指定された名前のジョブが見つからない場合に発生します。
例
実行中のジョブのストリーミング。
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
パラメーター
- raise_on_failure
- bool
検証が失敗した場合にエラーを発生させるかどうかを指定します。 既定値は False です。
戻り値
検出されたすべてのエラーを含む ValidationResult オブジェクト。
の戻り値の型 :
例外
指定された名前のジョブが見つからない場合に発生します。
例
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)
Azure SDK for Python