Job クラス

  • リファレンス

ジョブの基本クラスは、直接インスタンス化することはできません。

継承
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)

パラメーター

name
str
既定値: None

リソースの名前。

display_name
str
既定値: None

リソースの表示名。

description
str
既定値: None

リソースの説明。

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

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

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

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

experiment_name
str
既定値: None

ジョブが作成される実験の名前。None が指定されている場合、実験は現在のディレクトリに設定されます。

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

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

compute
str
既定値: None

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

kwargs
dict
必須

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

メソッド

dump

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

dump

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

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

パラメーター

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

このジョブのコンテンツを受信する宛先。 ローカル ファイルへのパス、または既に開いているファイル ストリームである必要があります。 dest がファイル パスの場合は、新しいファイルが作成され、ファイルが存在する場合は例外が発生します。 dest が開いているファイルの場合、ファイルは に直接書き込まれ、ファイルが書き込み可能でない場合は例外が発生します。

属性

base_path

リソースのベース パス。

戻り値

リソースのベース パス

の戻り値の型 :

str

creation_context

作成コンテキスト。

戻り値

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

の戻り値の型 :

Optional[SystemData]

id

リソースの ID

戻り値

リソースのグローバル ID、Azure Resource Manager ID

の戻り値の型 :

Optional[str]

log_files

ジョブ出力ファイル。

戻り値

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

の戻り値の型 :

<xref:Optional>[<xref:Dict>[str, str]]

status

ジョブの状態。

一般的には "Running"、"Completed"、"Failed" などの値が返されます。

Note

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

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

Provisioning - 指定したジョブの送信に関するオンデマンド コンピューティングが作成される場合に返されます。

Preparing - 次の実行環境を準備しています。

Docker イメージのビルド

Conda 環境のセットアップ

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

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

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

Finalizing - ユーザー コードが完了し、実行は後処理のステージになっています。

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

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

後処理のステージ。

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

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

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

戻り値

ジョブの状態。

の戻り値の型 :

str

studio_url

Azure ML Studio エンドポイント。

戻り値

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

の戻り値の型 :

<xref:Optional>[str]

type

サポートされているジョブの種類は 、'command' と 'sweep' です。

戻り値

ジョブの種類。

の戻り値の型 :

str