Job クラス

  • リファレンス

ジョブの基底クラス。

このクラスは直接インスタンス化しないでください。 代わりに、サブクラスの 1 つを使用します。

継承
azure.ai.ml.entities._resource.Resource
Job
azure.ai.ml.entities._job.pipeline._component_translatable.ComponentTranslatableMixin
Job
azure.ai.ml.entities._mixins.TelemetryMixin
Job

コンストラクター

Job(name: str | None = None, display_name: str | None = None, description: str | None = None, tags: Dict | None = None, properties: Dict | None = None, experiment_name: str | None = None, compute: str | None = None, services: Dict[str, JobService] | None = None, **kwargs: Dict)

パラメーター

name
Optional[str]
既定値: None

ジョブの名前。

display_name
Optional[str]
既定値: None

ジョブの表示名。

description
Optional[str]
既定値: None

ジョブの説明。

tags
Optional[dict[str, str]]
既定値: None

タグ辞書。 タグは追加、削除、更新できます。

properties
Optional[dict[str, str]]
既定値: None

ジョブ プロパティ ディクショナリ。

experiment_name
Optional[str]
既定値: None

ジョブが作成される実験の名前。 既定値は、現在のディレクトリの名前です。

services
Optional[dict[str, JobService]]
既定値: None

ジョブに関連付けられているサービスに関する情報。

compute
Optional[str]
既定値: None

ジョブに関連付けられているコンピューティング リソースに関する情報。

kwargs
dict

追加の構成パラメーターのディクショナリ。

メソッド

dump

ジョブの内容を YAML 形式のファイルにダンプします。

dump

ジョブの内容を YAML 形式のファイルにダンプします。

dump(dest: str | PathLike | IO, **kwargs) -> None

パラメーター

dest
Union[<xref:PathLike>, str, IO[AnyStr]]
必須

YAML コンテンツを書き込むローカル パスまたはファイル ストリーム。 dest がファイル パスの場合は、新しいファイルが作成されます。 dest が開いているファイルの場合、ファイルは に直接書き込まれます。

kwargs
dict

YAML シリアライザーに渡す追加の引数。

例外

FileExistsError

dest がファイル パスであり、ファイルが既に存在する場合に発生します。

IOError

dest が開いているファイルで、ファイルが書き込み可能でない場合に発生します。

属性

base_path

リソースのベース パス。

戻り値

リソースのベース パス。

の戻り値の型 :

str

creation_context

リソースの作成コンテキスト。

戻り値

リソースの作成メタデータ。

の戻り値の型 :

Optional[SystemData]

id

リソース ID。

戻り値

リソースのグローバル ID、Azure Resource Manager (ARM) ID。

の戻り値の型 :

Optional[str]

log_files

ジョブ出力ファイル。

戻り値

ログ名と URL のディクショナリ。

の戻り値の型 :

Optional[Dict[str, str]]

status

ジョブの状態。

一般的には "Running"、"Completed"、"Failed" などの値が返されます。 使用可能なすべての値は次のとおりです。

  • NotStarted - これは、クラウドの送信前にクライアント側の Run オブジェクトが存在する一時的な状態です。

  • Starting - クラウドで Run が処理され始めています。 この時点で、呼び出し元に実行 ID があります。

  • プロビジョニング - 特定のジョブの送信に対してオンデマンド コンピューティングが作成されています。

  • 準備中 - 実行環境は準備中であり、次の 2 つの段階のいずれかにあります。

    • Docker イメージのビルド

    • Conda 環境のセットアップ

  • Queued - ジョブはコンピューティング先でキューに入れられます。 たとえば、BatchAI では、ジョブはキューに入った状態です

    要求されたノードの準備が整うのを待機しています。

  • 実行中 - コンピューティング 先でジョブの実行が開始されました。

  • 最終処理 - ユーザー コードの実行が完了し、実行は後処理段階にあります。

  • CancelRequested - ジョブに対してキャンセルが要求されました。

  • 完了 - 実行が正常に完了しました。 これには、ユーザー コードの実行と実行の両方が含まれます

    後処理のステージ。

  • Failed - 実行に失敗しました。 通常は実行の Error プロパティで、理由に関する詳細が提供されます。

  • Canceled - キャンセル要求に従い、実行が現在正常にキャンセルされたことを示します。

  • NotResponding - ハートビートが有効になっている実行の場合、最近ハートビートが送信されていません。

戻り値

ジョブの状態。

の戻り値の型 :

Optional[str]

studio_url

Azure ML Studio エンドポイント。

戻り値

ジョブの詳細ページの URL。

の戻り値の型 :

Optional[str]

type

ジョブの種類。

戻り値

ジョブの種類。

の戻り値の型 :

Optional[str]