Legacy Python CLIコマンドリファレンス for AIランタイム

重要

このドキュメントは廃止されており、更新されない可能性があります。

Python ベースの air CLI は、databricks-air パッケージとともにインストールされますが、現在非推奨となっており、アクティブなメンテナンスは行われていません。

新しいワークロードには Databricks CLI を使用します。AI Runtime での Databricks CLI の使用を参照してください。

air CLI には、トレーニング ワークロードを管理するための 5 つのサブコマンド (air run、air get run、air list runs、air logs、air cancel) が用意されています。同じリファレンスは、CLI からいつでも直接利用できます。

Bash

air --help              # All commands
air <command> --help    # Flags for a specific command
air -h config           # YAML config reference
air -h config.compute   # Per-field help for a YAML section

CLIヘルプにはインストール済みの正確なバージョンが反映されるため、下表と異なる場合は、CLIヘルプが信頼できるソースとなります。

コマンド

コマンド	目的
air run	YAML ファイルによって定義されたワークロードを送信します。認証プロファイルを選択するために --file、--watch、--dry-run、--override、--idempotency-key、--email、および -p をサポートしています。
air get run	特定のランのメタデータ、ステータス、構成を表示します。
air list runs	最近のランをリスト表示します。--limit を使用して結果のカウントを制限し、--active を使用して実行中のワークロードのみを表示します。
air logs	ランの logs をストリームまたは download します。--node を使用して特定のノードをターゲットにし、--download-to を使用してディレクトリに logs を書き込みます。
air cancel	実行中のワークロードをキャンセルします。
air register image	ワークロードで使用するカスタム Docker イメージを登録してキャッシュします。「レガシー Python CLI でカスタム Docker イメージを使用する」を参照してください。

コマンド	目的
air run	YAML ファイルによって定義されたワークロードを送信します。認証プロファイルを選択するために --file、--watch、--dry-run、--override、--idempotency-key、--email、および -p をサポートしています。
air get run	特定のランのメタデータ、ステータス、構成を表示します。
air list runs	最近のランをリスト表示します。--limit を使用して結果のカウントを制限し、--active を使用して実行中のワークロードのみを表示します。
air logs	ランの logs をストリームまたは download します。--node を使用して特定のノードをターゲットにし、--download-to を使用してディレクトリに logs を書き込みます。
air cancel	実行中のワークロードをキャンセルします。
air register image	ワークロードで使用するカスタム Docker イメージを登録してキャッシュします。「レガシー Python CLI でカスタム Docker イメージを使用する」を参照してください。

グローバル フラグ

フラグ	目的
--version	インストールされているCLIバージョンを表示します。
-p, --profile	default の代わりに名前付き Databricks CLI 認証プロファイルを使用します。
-h, --help	ヘルプを表示します。設定パス (-h config.compute) が指定されている場合は、YAML フィールドのヘルプを表示します。

フラグ	目的
--version	インストールされているCLIバージョンを表示します。
-p, --profile	default の代わりに名前付き Databricks CLI 認証プロファイルを使用します。
-h, --help	ヘルプを表示します。設定パス (-h config.compute) が指定されている場合は、YAML フィールドのヘルプを表示します。

関連項目

• AI ランタイム向けのレガシー Python CLI クイックスタート
• レガシー Python CLI の Workload YAML リファレンス
• レガシー Python CLI でランを追跡する
• レガシー Python CLI でカスタム Dockerイメージを使用する