次の方法で共有

CommandJob クラス

  • リファレンス

コマンド ジョブ。

継承
azure.ai.ml.entities._job.job.Job
CommandJob
azure.ai.ml.entities._job.parameterized_command.ParameterizedCommand
CommandJob
azure.ai.ml.entities._job.job_io_mixin.JobIOMixin
CommandJob

コンストラクター

CommandJob(*, inputs: Dict[str, int | str | float | bool | Input] | None = None, outputs: Dict[str, Output] | None = None, limits: CommandJobLimits | None = None, identity: ManagedIdentityConfiguration | AmlTokenConfiguration | UserIdentityConfiguration | None = None, services: Dict[str, JobService | JupyterLabJobService | SshJobService | TensorBoardJobService | VsCodeJobService] | None = None, **kwargs)

パラメーター

services
Optional[dict[str, JobService]]

ジョブに関連付けられているサービスに関する読み取り専用情報。

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

コマンドで使用される出力データ バインディングのマッピング。

outputs
Optional[dict[str, Output]]

ジョブで使用される出力データ バインディングのマッピング。

identity
Optional[Union[ManagedIdentityConfiguration, AmlTokenConfiguration, UserIdentityConfiguration]]

コンピューティングでの実行中にジョブが使用する ID。

limits
Optional[CommandJobLimits]

ジョブの制限。

kwargs
dict

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

例

CommandJob の構成。


   command_job = CommandJob(
       code="./src",
       command="python train.py --ss {search_space.ss}",
       inputs={"input1": Input(path="trial.csv")},
       outputs={"default": Output(path="./foo")},
       compute="trial",
       environment="AzureML-sklearn-1.0-ubuntu20.04-py38-cpu:33",
       limits=CommandJobLimits(timeout=120),
   )

メソッド

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]

distribution

分散コマンド コンポーネントまたはジョブの構成。

戻り値

ディストリビューションの構成。

の戻り値の型 :

Union[PyTorchDistribution, MpiDistribution, TensorFlowDistribution, RayDistribution]

id

リソース ID。

戻り値

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

の戻り値の型 :

Optional[str]

inputs

log_files

ジョブ出力ファイル。

戻り値

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

の戻り値の型 :

Optional[Dict[str, str]]

outputs

parameters

MLFlow パラメーター。

戻り値

ジョブに記録された MLFlow パラメーター。

の戻り値の型 :

dict[str, str]

resources

コマンド コンポーネントまたはジョブのコンピューティング リソース構成。

戻り値

コマンド コンポーネントまたはジョブのコンピューティング リソース構成。

の戻り値の型 :

JobResourceConfiguration

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]