PipelineJob クラス

  • リファレンス

パイプライン ジョブ。

このクラスを直接インスタンス化しないでください。 代わりに、 @pipeline デコレーターを使用して PipelineJob を作成する必要があります。

] :p aram コンピューティング: ビルドされたパイプラインのコンピューティング先名。 既定値は None :type compute: str :p aram tags: Tag dictionary です。 タグは追加、削除、更新できます。 既定値は None :type tags: dict[str, str] :p aram kwargs: 追加の構成パラメーターのディクショナリです。 既定値は None :type kwargs: dict です

継承
azure.ai.ml.entities._job.job.Job
PipelineJob
azure.ai.ml.entities._mixins.YamlTranslatableMixin
PipelineJob
azure.ai.ml.entities._job.pipeline._io.mixin.PipelineJobIOMixin
PipelineJob
azure.ai.ml.entities._validation.path_aware_schema.PathAwareSchemaValidatableMixin
PipelineJob

コンストラクター

PipelineJob(*, component: str | PipelineComponent | None = None, inputs: Dict[str, int | str | float | bool | Input] | None = None, outputs: Dict[str, Output] | None = None, name: str | None = None, description: str | None = None, display_name: str | None = None, experiment_name: str | None = None, jobs: Dict[str, BaseNode] | None = None, settings: PipelineJobSettings | None = None, identity: ManagedIdentityConfiguration | AmlTokenConfiguration | UserIdentityConfiguration | None = None, compute: str | None = None, tags: Dict[str, str] | None = None, **kwargs)

パラメーター

component
Union[str, PipelineComponent]
必須

パイプライン コンポーネントのバージョン。 フィールドは 'jobs' と相互に排他的です。

inputs
dict[str, Union[<xref:azure.ai.ml.entities.Input>, str, bool, int, float]]
必須

パイプライン ジョブへの入力。

outputs
dict[str, <xref:azure.ai.ml.entities.Output>]
必須

パイプライン ジョブの出力。

name
str
必須

PipelineJob の名前。 既定値は None です

description
str
必須

パイプライン ジョブの説明。 既定値は None です

display_name
str
必須

パイプライン ジョブの表示名。 既定値は None です

experiment_name
str
必須

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

jobs
dict[str, <xref:azure.ai.ml.entities._builders.BaseNode>]
必須

コンポーネント オブジェクトへのパイプライン コンポーネント ノード名。 既定値は None です

settings
PipelineJobSettings
必須

パイプライン ジョブの設定。 既定値は None です

identity
Union[ ManagedIdentityConfiguration, AmlTokenConfiguration, UserIdentityConfiguration
必須

コンピューティングでの実行中にトレーニング ジョブが使用する ID。 既定値は None です

例

このクラスを使用してパイプラインを作成する方法を示します。


   from azure.ai.ml.entities import PipelineJob, PipelineJobSettings

   pipeline_job = PipelineJob(
       description="test pipeline job",
       tags={},
       display_name="test display name",
       experiment_name="pipeline_job_samples",
       properties={},
       settings=PipelineJobSettings(force_rerun=True, default_compute="cpu-cluster"),
       jobs={"component1": component_func(component_in_number=1.0, component_in_path=uri_file_input)},
   )
   ml_client.jobs.create_or_update(pipeline_job)

メソッド

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]

inputs

パイプライン ジョブの入力。

戻り値

パイプライン ジョブの入力。

の戻り値の型 :

dict[str, Union[Input, str, bool, int, float]]

jobs

パイプライン ジョブのジョブを返します。

戻り値

パイプライン ジョブのジョブ。

の戻り値の型 :

dict

log_files

ジョブ出力ファイル。

戻り値

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

の戻り値の型 :

Optional[Dict[str, str]]

outputs

パイプライン ジョブの出力。

戻り値

パイプライン ジョブの出力。

の戻り値の型 :

dict[str, Union[str, Output]]

settings

パイプライン ジョブの設定。

戻り値

パイプライン ジョブの設定。

の戻り値の型 :

PipelineJobSettings

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]