experiments コマンド グループ

注記

この情報は、Databricks CLI バージョン 0.205 以降に適用されます。Databricks CLI は パブリック プレビュー段階です。

Databricks CLI 使用には、使用状況データを含む Databricks ライセンス および Databricks プライバシー通知が適用されます。

Databricks CLI内のexperimentsコマンドグループを使用すると、MLflowでエクスペリメントを作成、編集、削除、および管理できます。MLflowエクスペリメントによるトレーニングランの整理を参照してください。

databricks experiments create-experiment

名前付きのエクスペリメントを作成します。 新しく作成したエクスペリメントの ID を返します。 同じ名前の別のエクスペリメントがまだ存在しないことを検証し、同じ名前の別のエクスペリメントがすでに存在する場合は失敗します。

指定された名前のエクスペリメントが存在する場合は RESOURCE_ALREADY_EXISTS スローします。

databricks experiments create-experiment NAME [flags]

引数

NAME

エクスペリメント名。

オプション

--artifact-location string

エクスペリメントのすべてのアーティファクトが格納されている場所。

--json JSON

インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。

グローバルフラグ

databricks experiments create-run

エクスペリメント内で新しい実行を作成します。 実行は通常、機械学習またはデータ ETL パイプラインの 1 回の実行です。MLflow では、実行を使用して、1 回の実行に関連付けられている mlflowParam、mlflowMetric、mlflowRunTag を追跡します。

databricks experiments create-run [flags]

引数

なし

オプション

--experiment-id string

関連付けられているエクスペリメントの ID。

--json JSON

インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path

--run-name string

実行の名前。

--start-time int

実行開始時のミリ秒単位の Unix タイムスタンプ。

--user-id string

実行を実行しているユーザーの ID。

グローバルフラグ

databricks experiments delete-experiment

エクスペリメントと関連するメタデータ、実行、メトリクス、params、およびタグを削除対象にマークします。 エクスペリメントが FileStore を使用している場合、エクスペリメントに関連付けられたアーティファクトも削除されます。

databricks experiments delete-experiment EXPERIMENT_ID [flags]

引数

EXPERIMENT_ID

関連付けられているエクスペリメントの ID。

オプション

--json JSON

インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path

グローバルフラグ

databricks experiments delete-実行

実行を削除対象としてマークします。

databricks experiments delete-run RUN_ID [flags]

引数

RUN_ID

削除する実行の ID。

オプション

--json JSON

インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path

グローバルフラグ

databricks experiments delete-runs

Bulk delete 実行 で エクスペリメント 指定されたタイムスタンプの前またはタイムスタンプで作成されました。 要求ごとに最大max_runs削除します。PythonのDatabricksノートブックからこのAPIを呼び出すには、 のクライアントコードスニペットを使用します。

databricks experiments delete-runs EXPERIMENT_ID MAX_TIMESTAMP_MILLIS [flags]

引数

EXPERIMENT_ID

削除する実行を含むエクスペリメントの ID。

MAX_TIMESTAMP_MILLIS

実行を削除するための UNIX エポック以降の最大作成タイムスタンプ (ミリ秒単位)。このタイムスタンプより前またはこのタイムスタンプで作成された実行のみが削除されます。

オプション

--json JSON

インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path

--max-runs int

削除する実行の最大数を示すオプションの正の整数。

グローバルフラグ

databricks experiments delete-tag

実行時にタグを削除します。タグは、実行中および実行の完了後に更新できる実行メタデータです。

databricks experiments delete-tag RUN_ID KEY [flags]

引数

RUN_ID

タグがログに記録された実行の ID。必須。

KEY

タグの名前。最大サイズは 255 バイトです。必須。

オプション

--json JSON

インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path

グローバルフラグ

databricks experiments get-by-name

指定した名前のエクスペリメントのメタデータを取得します。

このコマンドは削除されたエクスペリメントを返しますが、アクティブなエクスペリメントと削除されたエクスペリメントが同じ名前を共有している場合は、アクティブなエクスペリメントが優先されます。 削除された複数のエクスペリメントが同じ名前を共有している場合、 API はそのうちの 1 つを返します。

指定した名前のエクスペリメントが存在しない場合に RESOURCE_DOES_NOT_EXIST スローします。

databricks experiments get-by-name EXPERIMENT_NAME [flags]

引数

EXPERIMENT_NAME

関連付けられているエクスペリメントの名前。

オプション

グローバルフラグ

databricks experiments get-experiment

指定した ID を持つエクスペリメントのメタデータを取得します。 このコマンドは、削除されたエクスペリメントに対して機能します。

databricks experiments get-experiment EXPERIMENT_ID [flags]

引数

EXPERIMENT_ID

関連付けられているエクスペリメントの ID。

オプション

グローバルフラグ

databricks experiments get-history

指定された メトリクス 特定の実行のすべての値のリストを取得します。

databricks experiments get-history METRIC_KEY [flags]

引数

METRIC_KEY

メトリクスの名前。

オプション

--max-results int

ページ分割された要求ごとに返されるメトリクスレコードの最大数。

--page-token string

取得するメトリクス履歴のページを示すトークン。

--run-id string

メトリクス値をフェッチする実行の ID。

--run-uuid string

非推奨の場合は、代わりに --run_id を使用してください。メトリクス値をフェッチする実行の ID。

グローバルフラグ

databricks experiments get-execute

メタデータを取得します、 メトリクス、 パラメータ、およびタグ 実行。 実行に対して同じキーを持つ複数のメトリクスがログに記録される場合は、最新のタイムスタンプを持つ値のみを返します。

最新のタイムスタンプを持つ値が複数ある場合は、これらの値の最大値を返します。

databricks experiments get-run RUN_ID [flags]

引数

RUN_ID

フェッチする実行の ID。提供する必要があります。

オプション

--run-uuid string

非推奨の場合は、代わりに --run_id を使用してください。フェッチする実行の ID。

グローバルフラグ

databricks experiments list-artifacts

List アーティファクト for a 実行. オプションのartifact_pathプレフィックスを受け取りますが、指定すると、指定されたプレフィックスを持つアーティファクトのみが応答に含まれます。 Unity Catalog ボリュームに対して最大 1000 アーティファクトが取得されます。ページネーションをサポートするアーティファクトをUnity Catalogボリュームに一覧表示するには、databricks fs ls を使用します。

databricks experiments list-artifacts [flags]

引数

なし

オプション

--page-token string

取得するアーティファクトの結果のページを示すトークン。

--path string

このパスに一致するアーティファクトをフィルター処理します (ルートアーティファクトディレクトリからの相対パス)。

--run-id string

アーティファクトを一覧表示する実行の ID。

--run-uuid string

非推奨の場合は、代わりに --run_id を使用してください。アーティファクトを一覧表示する実行の ID。

グローバルフラグ

databricks experiments list-experiments

すべてのエクスペリメントのリストを取得します。

databricks experiments list-experiments [flags]

引数

なし

オプション

--max-results int

エクスペリメントの最大数。

--page-token string

取得するエクスペリメントのページを示すトークン。

--view-type ViewType

返されるエクスペリメントのタイプの修飾子。 サポートされている値: ACTIVE_ONLY、 ALL、 DELETED_ONLY

グローバルフラグ

databricks experiments log-batch

実行のメトリクス、params、およびタグのバッチをログに記録します。 データの永続化に失敗した場合、サーバーはエラー (200 以外のステータス コード) で応答します。上書き動作と要求制限については、「 エクスペリメント」を参照してください。

databricks experiments log-batch [flags]

引数

なし

オプション

--json JSON

インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。

--run-id string

ログに記録する実行の ID。

グローバルフラグ

databricks experiments log-inputs

注記

このコマンドは実験的です。

データセットやモデルなどの入力を MLflow 実行に記録します。

databricks experiments log-inputs RUN_ID [flags]

引数

RUN_ID

ログに記録する実行の ID

オプション

--json JSON

インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。

グローバルフラグ

databricks experiments log-metric

実行のためのメトリクスをログに記録します。 メトリクスは、タイムスタンプが関連付けられたキーと値のペア (文字列 key, float value) です。 例としては、ML モデルの精度を表すさまざまなメトリクスが含まれます。メトリクスは複数回記録できます。

databricks experiments log-metric KEY VALUE TIMESTAMP [flags]

引数

KEY

メトリクスの名前。

VALUE

ログに記録されるメトリクスの 2 倍の値。

TIMESTAMP

メトリクスがログに記録されたときのUnixタイムスタンプ(ミリ秒単位)。

オプション

--dataset-digest string

データセット メトリクスに関連付けられたデータセットのダイジェスト、例えば

--dataset-name string

メトリクスに関連付けられているデータセットの名前。

--json JSON

インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。

--model-id string

記録済みモデルの ID メトリクスに関連付けられています (該当する場合)。

--run-id string

メトリクスをログに記録する実行の ID。

--run-uuid string

非推奨の場合は、代わりに --run_id を使用してください。メトリクスをログに記録する実行の ID。

--step int

メトリクスをログに記録するステップ。

グローバルフラグ

databricks experiments log-model

モデルをログに記録します。

注記

このコマンドは実験的です。

databricks experiments log-model [flags]

引数

なし

オプション

--json JSON

インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。

--model-json string

MLmodel ファイルを JSON 形式で保存します。

--run-id string

ログに記録する実行の ID。

グローバルフラグ

databricks experiments log-param

実行に使用されたパラメーターをログに記録します。param は、キーと値のペア (文字列キー、文字列値) です。例としては、ML モデルのトレーニングに使用されるハイパーパラメータや、ETL パイプラインで使用される定数の日付と値などがあります。パラメータは、実行に対して一度だけログに記録できます。

databricks experiments log-param KEY VALUE [flags]

引数

KEY

パラメータの名前。最大サイズは 255 バイトです。

VALUE

ログに記録されるパラメータの文字列値。最大サイズは 500 バイトです。

オプション

--json JSON

インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。

--run-id string

パラメータをログに記録する実行の ID。

--run-uuid string

[非推奨、代わりにrun_idを使用してください]パラメータをログに記録する実行の ID。

グローバルフラグ

databricks experiments restore-experiment

削除対象としてマークされたエクスペリメントを復元します。 これにより、関連するメタデータ、実行、メトリクス、params、およびタグも復元されます。 エクスペリメントが FileStore を使用する場合、エクスペリメントに関連付けられた基礎となるアーティファクトも復元されます。

エクスペリメントが作成されていないか、完全に削除された場合は RESOURCE_DOES_NOT_EXIST スローします。

databricks experiments restore-experiment EXPERIMENT_ID [flags]

引数

EXPERIMENT_ID

関連付けられているエクスペリメントの ID。

オプション

--json JSON

インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。

グローバルフラグ

databricks experiments restore-run

削除された実行を復元します。これにより、関連するメタデータ、実行、メトリクス、params、およびタグも復元されます。

実行が作成されていないか、完全に削除された場合は RESOURCE_DOES_NOT_EXIST スローします。

databricks experiments restore-run RUN_ID [flags]

引数

RUN_ID

復元する実行の ID。

オプション

--json JSON

インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。

グローバルフラグ

databricks experiments restore-runs

Bulk restore 実行 エクスペリメントで実行し、指定されたタイムスタンプより前に削除されました。 要求ごとに最大 max_runs を復元します。

databricks experiments restore-runs EXPERIMENT_ID MIN_TIMESTAMP_MILLIS [flags]

引数

EXPERIMENT_ID

リストアする実行を含むエクスペリメントの ID。

MIN_TIMESTAMP_MILLIS

実行を復元するための UNIX エポック以降の最小削除タイムスタンプ (ミリ秒単位)。このタイムスタンプより前に削除された実行のみが復元されます。

オプション

--json JSON

インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。

--max-runs int

復元する実行の最大数を示すオプションの正の整数。

グローバルフラグ

databricks experiments search-experiments

指定した検索条件を満たすエクスペリメントを検索します。

databricks experiments search-experiments [flags]

引数

なし

オプション

--filter string

SQL フィルター条件を表す文字列

--json JSON

インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。

--max-results int

エクスペリメントの最大数。

--page-token string

取得するエクスペリメントのページを示すトークン。

--view-type ViewType

返されるエクスペリメントのタイプの修飾子。 サポートされている値: ACTIVE_ONLY、 ALL、 DELETED_ONLY

グローバルフラグ

databricks experiments search-runs

式を満たす実行を検索します。検索式では、mlflowMetric キーと mlflowParam キーを使用できます。

databricks experiments search-runs [flags]

引数

なし

オプション

--filter string

params、メトリクス、およびタグに対するフィルター式で、実行のサブセットを返すことができます。

--json JSON

インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。

--max-results int

必要な実行の最大数。

--page-token string

実行の現在のページのトークン。

--run-view-type ViewType

アクティブな実行のみを表示するか、削除された実行のみを表示するか、またはすべての実行を表示するか。サポートされている値: ACTIVE_ONLY、 ALL、 DELETED_ONLY

グローバルフラグ

databricks experiments set-experiment-tag

エクスペリメントにタグを設定します。 エクスペリメントタグは、更新可能なメタデータです。

databricks experiments set-experiment-tag EXPERIMENT_ID KEY VALUE [flags]

引数

EXPERIMENT_ID

タグをログに記録するエクスペリメントの ID。 提供する必要があります。

KEY

タグの名前。最大 250 バイトのサイズのキーがサポートされています。

VALUE

ログに記録されるタグの文字列値。最大 64 KB のサイズの値がサポートされています。

オプション

--json JSON

インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。

グローバルフラグ

databricks experiments set-tag

実行時にタグを設定します。タグは、実行中および実行の完了後に更新できる実行メタデータです。

databricks experiments set-tag KEY VALUE [flags]

引数

KEY

タグの名前。最大 250 バイトのサイズのキーがサポートされています。

VALUE

ログに記録されるタグの文字列値。最大 64 KB のサイズの値がサポートされています。

オプション

--json JSON

インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。

--run-id string

タグをログに記録する実行の ID。

--run-uuid string

非推奨の場合は、代わりに --run_id を使用してください。タグをログに記録する実行の ID。

グローバルフラグ

databricks experiments update-experiment

エクスペリメントを更新します。

databricks experiments update-experiment EXPERIMENT_ID [flags]

引数

EXPERIMENT_ID

関連付けられているエクスペリメントの ID。

オプション

--json JSON

インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。

--new-name string

指定すると、エクスペリメントの名前が新しい名前に変更されます。

グローバルフラグ

databricks experiments update-run

実行を更新します。

databricks experiments update-run [flags]

引数

なし

オプション

--end-time int

実行が終了したときのミリ秒単位のUnixタイムスタンプ。

--json JSON

インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。

--run-id string

更新する実行の ID。

--run-name string

実行の名前を更新しました。

--run-uuid string

非推奨の場合は、代わりに --run_id を使用してください。更新する実行の ID。

--status UpdateRunStatus

実行のステータスが更新されました。サポートされている値: FAILED、 FINISHED、 KILLED、 RUNNING、 SCHEDULED

グローバルフラグ

databricks experiments get-permission-levels

エクスペリメントの権限レベルを取得します。

databricks experiments get-permission-levels EXPERIMENT_ID [flags]

引数

EXPERIMENT_ID

アクセス許可を取得または管理するエクスペリメント。

オプション

グローバルフラグ

databricks experiments get-permissions

エクスペリメントの権限を取得します。 エクスペリメントは、ルートオブジェクトから権限を継承できます。

databricks experiments get-permissions EXPERIMENT_ID [flags]

引数

EXPERIMENT_ID

アクセス許可を取得または管理するエクスペリメント。

オプション

グローバルフラグ

databricks experiments set-permissions

エクスペリメントの権限を設定します。

オブジェクトに対する権限を設定し、既存の権限が存在する場合は置き換えます。指定されていない場合は、すべての直接アクセス許可を削除します。オブジェクトは、ルート オブジェクトからアクセス許可を継承できます。

databricks experiments set-permissions EXPERIMENT_ID [flags]

引数

EXPERIMENT_ID

アクセス許可を取得または管理するエクスペリメント。

オプション

--json JSON

インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。

グローバルフラグ

databricks experiments update-permissions

エクスペリメントの権限を更新します。 エクスペリメントは、ルートオブジェクトから権限を継承できます。

databricks experiments update-permissions EXPERIMENT_ID [flags]

引数

EXPERIMENT_ID

アクセス許可を取得または管理するエクスペリメント。

オプション

--json JSON

インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。

グローバルフラグ

グローバルフラグ

--debug

デバッグログを有効にするかどうか。

-h または --help

Databricks CLI、関連するコマンド グループ、または関連するコマンドのヘルプを表示します。

--log-file string

出力ログの書き込み先となるファイルを表す文字列。このフラグが指定されていない場合、デフォルトでは出力ログが stderr に書き込まれます。

--log-format format

ログ・フォーマット・タイプ ( text または json) 。デフォルト値は textです。

--log-level string

ログ形式レベルを表す文字列。指定しない場合、ログ・フォーマット・レベルは使用不可になります。

-o, --output タイプ

コマンド出力タイプ text または json。デフォルト値は textです。

-p, --profile string

コマンドの実行に使用する ~/.databrickscfg ファイル内のプロファイルの名前。このフラグが指定されていない場合、存在する場合は、 DEFAULT という名前のプロファイルが使用されます。

--progress-format format

進行状況ログを表示する形式: default、 append、 inplace、 json

-t, --target string

該当する場合は、使用するバンドル・ターゲット