experiments コマンド グループ

Note

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

Databricks CLI の使用には、Databricks ライセンスおよび使用状況データのプロビジョニングを含むDatabricks のプライバシーに関する通知が適用されます。

experiments 内の コマンド グループを使用すると、MLflow で実験を作成、編集、削除、管理できます。 「MLflow 実験を使用してトレーニング実行を整理する」を参照してください。

databricks 実験の作成コマンド

名前を使用して実験を作成します。 新しく作成された実験の ID を返します。 同じ名前の別の実験がまだ存在しないことを検証し、同じ名前の別の実験が既に存在する場合は失敗します。

指定した名前の実験が存在する場合は、RESOURCE_ALREADY_EXISTS をスローします。

databricks experiments create-experiment NAME [flags]

Arguments

NAME

    実験名。

オプション

--artifact-location string

    実験のすべての成果物が格納される場所。

--json JSON

    要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。

グローバル フラグ

databricks の実験の作成と実行

実験内に新しい実行を作成します。 通常、実行は、機械学習またはデータ ETL パイプラインの 1 回の実行です。 MLflow は、1回の実行に関連する mlflowParam、mlflowMetric、mlflowRunTag を追跡します。

databricks experiments create-run [flags]

Arguments

None

オプション

--experiment-id string

    関連付けられている実験の ID。

--json JSON

    要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path

--run-name string

    実行の名前。

--start-time int

    実行が開始されたときの Unix タイムスタンプ (ミリ秒単位)。

--user-id string

    実行中のユーザーの ID。

グローバル フラグ

databricks 実験の削除 (delete-experiment)

実験と関連するメタデータ、実行、メトリック、パラメーター、およびタグを削除対象としてマークします。 実験で FileStore を使用している場合、実験に関連付けられている成果物も削除されます。

databricks experiments delete-experiment EXPERIMENT_ID [flags]

Arguments

EXPERIMENT_ID

    関連付けられている実験の ID。

オプション

--json JSON

    要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path

グローバル フラグ

databricks 実験のランを削除

実行に削除のマークを付けます。

databricks experiments delete-run RUN_ID [flags]

Arguments

RUN_ID

    削除する実行の ID

オプション

--json JSON

    要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path

グローバル フラグ

databricks 実験の実行を削除

実験で指定されたタイムスタンプ以前または同時に作成された実行を一括削除します。 要求ごとに最大の max_runs を削除します。 Python の Databricks Notebook からこの API を呼び出すには、クライアントコードスニペットを使用できます。

databricks experiments delete-runs EXPERIMENT_ID MAX_TIMESTAMP_MILLIS [flags]

Arguments

EXPERIMENT_ID

    削除する実行を含む実験の ID。

MAX_TIMESTAMP_MILLIS

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

オプション

--json JSON

    要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path

--max-runs int

    削除する実行の最大数を示す、省略可能な正の整数。

グローバル フラグ

databricks 実験 削除タグ

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

databricks experiments delete-tag RUN_ID KEY [flags]

Arguments

RUN_ID

    タグが記録された実行の ID。 Required.

KEY

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

オプション

--json JSON

    要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path

グローバル フラグ

databricks 実験の get-by-name

指定した名前の実験のメタデータを取得します。

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

指定された名前の実験が存在しない場合、RESOURCE_DOES_NOT_EXIST を投げます。

databricks experiments get-by-name EXPERIMENT_NAME [flags]

Arguments

EXPERIMENT_NAME

    関連付けられている実験の名前。

オプション

グローバル フラグ

databricks 実験 get-experiment

指定した ID を持つ実験のメタデータを取得します。 このコマンドは、削除された実験で機能します。

databricks experiments get-experiment EXPERIMENT_ID [flags]

Arguments

EXPERIMENT_ID

    関連付けられている実験の ID。

オプション

グローバル フラグ

databricks 実験の履歴を取得

特定の実行に対して指定されたメトリックのすべての値の一覧を取得します。

databricks experiments get-history METRIC_KEY [flags]

Arguments

METRIC_KEY

    メトリックの名前。

オプション

--max-results int

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

--page-token string

    メトリック履歴のページを取得するためのデジタルトークンを示します。

--run-id string

    実行からメトリック値を取得するための ID。

--run-uuid string

    非推奨、代わりに --run_id を使用してください。 実行からメトリック値を取得するための ID。

グローバル フラグ

databricks の実験 get-run

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

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

databricks experiments get-run RUN_ID [flags]

Arguments

RUN_ID

    フェッチするための実行 ID。 指定する必要があります。

オプション

--run-uuid string

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

グローバル フラグ

databricks 実験のアーティファクト一覧表示

実行の成果物を一覧表示します。 省略可能なartifact_pathプレフィックスを受け取ります。指定した場合、応答には指定されたプレフィックスを持つ成果物のみが含まれます。 Unity カタログ ボリュームに対して最大 1,000 個のアーティファクトが取得されます。 Databricks fs ls を使用して、改ページをサポートする Unity カタログ ボリュームの成果物を一覧表示します。

databricks experiments list-artifacts [flags]

Arguments

None

オプション

--page-token string

    取得する成果物結果のページを示すトークン。

--path string

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

--run-id string

    成果物を一覧表示する実行の ID。

--run-uuid string

    非推奨、代わりに --run_id を使用してください。 成果物を一覧表示する実行の ID。

グローバル フラグ

databricks 実験 リスト-実験

すべての実験の一覧を取得します。

databricks experiments list-experiments [flags]

Arguments

None

オプション

--max-results int

    必要な実験の最大数。

--page-token string

    取得する実験のページを示すトークン。

--view-type ViewType

    返却される実験の種類を示す修飾子。 サポートされる値: ACTIVE_ONLY、ALL、DELETED_ONLY

グローバル フラグ

databricks の実験ログバッチ

実行のメトリック、パラメーター、タグのバッチをログに記録します。 データを保持できなかった場合、サーバーはエラー (200 以外の状態コード) で応答します。 上書きの動作と要求の制限については、「 実験」を参照してください。

databricks experiments log-batch [flags]

Arguments

None

オプション

--json JSON

    要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。

--run-id string

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

グローバル フラグ

databricks 実験の入力を記録する

Note

このコマンドは試験段階です。

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

databricks experiments log-inputs RUN_ID [flags]

Arguments

RUN_ID

    ログを記録する実行の ID

オプション

--json JSON

    要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。

グローバル フラグ

databricks 実験のログメトリック

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

databricks experiments log-metric KEY VALUE TIMESTAMP [flags]

Arguments

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 の実験モデル記録

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

Note

このコマンドは試験段階です。

databricks experiments log-model [flags]

Arguments

None

オプション

--json JSON

    要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。

--model-json string

    JSON 形式の MLmodel ファイル。

--run-id string

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

グローバル フラグ

Databricks エクスペリメントのログパラメータ

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

databricks experiments log-param KEY VALUE [flags]

Arguments

KEY

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

VALUE

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

オプション

--json JSON

    要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。

--run-id string

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

--run-uuid string

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

グローバル フラグ

databricks 実験の復元実験

削除対象としてマークされた実験を復元します。 これにより、関連付けられているメタデータ、実行、メトリック、パラメーター、タグも復元されます。 実験で FileStore を使用する場合は、実験に関連付けられている基になる成果物も復元されます。

実験が一度も作成されていないか、完全に削除された場合にRESOURCE_DOES_NOT_EXISTを投げます。

databricks experiments restore-experiment EXPERIMENT_ID [flags]

Arguments

EXPERIMENT_ID

    関連付けられている実験の ID。

オプション

--json JSON

    要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。

グローバル フラグ

databricks の実験の restore-run

削除された実行を復元します。 これにより、関連付けられているメタデータ、実行、メトリック、パラメーター、タグも復元されます。

実行が一度も作成されなかったか、永久に削除された場合に、RESOURCE_DOES_NOT_EXIST をスローします。

databricks experiments restore-run RUN_ID [flags]

Arguments

RUN_ID

    復元する実行の ID。

オプション

--json JSON

    要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。

グローバル フラグ

databricks 実験の実行を復元する

一括復元が、指定されたタイムスタンプより前に削除された実験で実行されます。 要求ごとに最大の max_runs を復元します。

databricks experiments restore-runs EXPERIMENT_ID MIN_TIMESTAMP_MILLIS [flags]

Arguments

EXPERIMENT_ID

    復元する実行を含む実験の ID。

MIN_TIMESTAMP_MILLIS

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

オプション

--json JSON

    要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。

--max-runs int

    復元する実行の最大数を示す、省略可能な正の整数。

グローバル フラグ

Databricks の実験検索-実験

指定した検索条件を満たす実験を検索します。

databricks experiments search-experiments [flags]

Arguments

None

オプション

--filter string

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

--json JSON

    要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。

--max-results int

    必要な実験の最大数。

--page-token string

    取得する実験のページを示すトークン。

--view-type ViewType

    返却される実験の種類を示す修飾子。 サポートされる値: ACTIVE_ONLY、ALL、DELETED_ONLY

グローバル フラグ

databricks の実験の検索実行

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

databricks experiments search-runs [flags]

Arguments

None

オプション

--filter string

    パラメーター、メトリック、タグを用いたフィルター式によって、実行のサブセットを返すことができます。

--json JSON

    要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。

--max-results int

    必要な実行の最大数。

--page-token string

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

--run-view-type ViewType

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

グローバル フラグ

databricks 実験 set-experiment-tag

実験にタグを設定します。 実験タグは、更新できるメタデータです。

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

Arguments

EXPERIMENT_ID

    タグをログに記録する実験の ID。 指定する必要があります。

KEY

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

VALUE

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

オプション

--json JSON

    要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。

グローバル フラグ

databricks 実験: set-tag

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

databricks experiments set-tag KEY VALUE [flags]

Arguments

KEY

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

VALUE

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

オプション

--json JSON

    要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。

--run-id string

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

--run-uuid string

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

グローバル フラグ

Databricks の実験「update-experiment」

実験を更新します。

databricks experiments update-experiment EXPERIMENT_ID [flags]

Arguments

EXPERIMENT_ID

    関連付けられている実験の ID。

オプション

--json JSON

    要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。

--new-name string

    指定した場合、実験の名前が新しい名前に変更されます。

グローバル フラグ

databricks 実験の update-run

実行を更新します。

databricks experiments update-run [flags]

Arguments

None

オプション

--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 エクスペリメントの get-permission-levels

実験のアクセス許可レベルを取得します。

databricks experiments get-permission-levels EXPERIMENT_ID [flags]

Arguments

EXPERIMENT_ID

    アクセス許可を取得または管理する実験。

オプション

グローバル フラグ

databricks 実験の権限取得

実験のアクセス許可を取得します。 実験は、ルート オブジェクトからアクセス許可を継承できます。

databricks experiments get-permissions EXPERIMENT_ID [flags]

Arguments

EXPERIMENT_ID

    アクセス許可を取得または管理する実験。

オプション

グローバル フラグ

Databricks 実験の「set-permissions」

実験のアクセス許可を設定します。

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

databricks experiments set-permissions EXPERIMENT_ID [flags]

Arguments

EXPERIMENT_ID

    アクセス許可を取得または管理する実験。

オプション

--json JSON

    要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。

グローバル フラグ

Databricks 実験の権限の更新

実験のアクセス許可を更新します。 実験は、ルート オブジェクトからアクセス許可を継承できます。

databricks experiments update-permissions EXPERIMENT_ID [flags]

Arguments

EXPERIMENT_ID

    アクセス許可を取得または管理する実験。

オプション

--json JSON

    要求本文を含む JSON ファイルに対するインライン JSON 文字列または @path。

グローバル フラグ

グローバル フラグ

--debug

  デバッグ ログを有効にするかどうかを指定します。

-h または --help

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

--log-file 文字列

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

--log-format 形式

    ログ形式の種類、 text 、または json。 既定値は text です。

--log-level 文字列

    ログ形式レベルを表す文字列。 指定しない場合、ログ形式レベルは無効になります。

-o, --output 型

    コマンド出力の種類( text または json)。 既定値は text です。

-p, --profile 文字列

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

--progress-format 形式

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

-t, --target 文字列

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