Note
Databricks CLI 的使用受限於 Databricks 授權 和 Databricks 隱私權聲明，包括任何使用數據條款。
experiments
Databricks CLI 中的指令群組允許你在 MLflow 中建立、編輯、刪除及管理實驗。 請參閱 使用 MLflow 實驗組織訓練回合。
databricks 實驗命令 create-experiment
使用名稱建立實驗。 傳回新建立實驗的標識碼。 驗證具有相同名稱的另一個實驗不存在，如果已有同名的另一個實驗存在，就會失敗。
如果存在具有指定名稱的實驗，則拋出RESOURCE_ALREADY_EXISTS。
databricks experiments create-experiment NAME [flags]
Arguments
NAME
實驗名稱。
選項
--artifact-location string
儲存實驗所有成品的位置。
--json JSON
內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。
Databricks 實驗 建立-logged-model
建立一個有記錄的模型。
databricks experiments create-logged-model EXPERIMENT_ID [flags]
Arguments
EXPERIMENT_ID
擁有該模型的實驗ID。
選項
--json JSON
內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。
--model-type string
模型的類型，例如 Agent、 Classifier、 或 LLM。
--name string
型號名稱（可選）。
--source-run-id string
就是創建模型的那次運行的ID。
Examples
以下範例建立一個對數模型：
databricks experiments create-logged-model 123456789 --name my-model --model-type LLM
databricks 實驗創建執行
在實驗中建立一次新的運行。 通常，「運行」指的是單次執行機器學習或數據 ETL 管道。 MLflow 會使用執行來追蹤與單一執行相關聯的 mlflowParam、mlflowMetric 和 mlflowRunTag。
databricks experiments create-run [flags]
Arguments
None
選項
--experiment-id string
相關聯實驗的標識碼。
--json JSON
內嵌 JSON 字串或 @path 指向 JSON 檔案的要求本文
--run-name string
執行步驟名稱。
--start-time int
執行啟動時的 Unix 時間戳，以毫秒為單位。
--user-id string
執行運行的使用者識別碼。
databricks 實驗 delete-experiment
標記實驗及其相關的元數據、執行次數、衡量指標、參數和標記以進行刪除。 如果實驗使用 FileStore，實驗相關的工件也會被刪除。
databricks experiments delete-experiment EXPERIMENT_ID [flags]
Arguments
EXPERIMENT_ID
相關聯實驗的標識碼。
選項
--json JSON
內嵌 JSON 字串或 @path 指向 JSON 檔案的要求本文
Databricks experiments delete-logged-model
刪除已記錄的模型。
databricks experiments delete-logged-model MODEL_ID [flags]
Arguments
MODEL_ID
要刪除的已記錄模型的 ID。
選項
Examples
以下範例刪除已記錄的模型：
databricks experiments delete-logged-model m-1234567890abcdef
Databricks experiments delete-logged-model-tag
刪除已記錄模型的標籤。
databricks experiments delete-logged-model-tag MODEL_ID TAG_KEY [flags]
Arguments
MODEL_ID
刪除標籤的已記錄模型的 ID。
TAG_KEY
刪除的標籤鍵。
選項
Examples
以下範例是從已記錄的模型中刪除標籤：
databricks experiments delete-logged-model-tag m-1234567890abcdef my-tag-key
databricks 實驗 delete-run
標示要刪除的回合。
databricks experiments delete-run RUN_ID [flags]
Arguments
RUN_ID
要刪除的執行識別碼。
選項
--json JSON
內嵌 JSON 字串或 @path 指向 JSON 檔案的要求本文
databricks 實驗 delete-runs
在實驗中大量刪除在指定時間戳之前或在指定時間戳建立的執行運行。 每個要求最多刪除 max_runs 次。 若要從 Python 中的 Databricks Notebook 呼叫此 API，您可以使用 上的用戶端代碼段
databricks experiments delete-runs EXPERIMENT_ID MAX_TIMESTAMP_MILLIS [flags]
Arguments
EXPERIMENT_ID
包含要刪除執行紀錄的實驗 ID。
MAX_TIMESTAMP_MILLIS
從 UNIX epoch 開始刪除執行以來的建立時間戳上限，以毫秒為單位。 只會刪除在此時間戳記之前或之上建立的執行。
選項
--json JSON
內嵌 JSON 字串或 @path 指向 JSON 檔案的要求本文
--max-runs int
選擇性正整數，表示要刪除的執行數目上限。
databricks 實驗 刪除標籤
刪除運行中的標籤。 標記是可在執行期間和執行完成之後更新的執行元數據。
databricks experiments delete-tag RUN_ID KEY [flags]
Arguments
RUN_ID
標記所屬執行的識別碼。 Required.
KEY
標記的名稱。 大小上限為 255 個字節。 Required.
選項
--json JSON
內嵌 JSON 字串或 @path 指向 JSON 檔案的要求本文
Databricks experiments finalize-logged-model
完成一個已記錄的模型，標記為已完成或失敗。
databricks experiments finalize-logged-model MODEL_ID STATUS [flags]
Arguments
MODEL_ID
用來完成記錄的模型 ID。
STATUS
模型是否已準備好使用。 支援的值：LOGGED_MODEL_PENDING、LOGGED_MODEL_READY、LOGGED_MODEL_UPLOAD_FAILED。
選項
--json JSON
內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。
Examples
以下範例標示已記錄的模型為準備就緒：
databricks experiments finalize-logged-model m-1234567890abcdef LOGGED_MODEL_READY
databricks 實驗依名稱取得
取得具有指定名稱之實驗的元數據。
此命令會回傳已刪除的實驗，但如果有作用中實驗與已刪除的實驗共用相同名稱，則會優先選擇作用中實驗。 如果多個已刪除的實驗共用相同的名稱，API 會傳回其中一個。
RESOURCE_DOES_NOT_EXIST如果沒有具有指定名稱的實驗存在，則會擲回 。
databricks experiments get-by-name EXPERIMENT_NAME [flags]
Arguments
EXPERIMENT_NAME
相關聯實驗的名稱。
選項
databricks 實驗 get-experiment
取得具有指定標識碼之實驗的元數據。 此命令適用於已刪除的實驗。
databricks experiments get-experiment EXPERIMENT_ID [flags]
Arguments
EXPERIMENT_ID
相關聯實驗的標識碼。
選項
databricks 實驗 "get-history"
取得特定執行中的指定指標的所有值清單。
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 experiments get-logged-model
買一個有記錄的模型。
databricks experiments get-logged-model MODEL_ID [flags]
Arguments
MODEL_ID
要取回已記錄模型的 ID。
選項
Examples
以下範例得到一個對數模型：
databricks experiments get-logged-model m-1234567890abcdef
databricks 實驗執行狀態查詢
取得執行的元數據、計量、參數和標籤。 如果針對執行記錄了多個具有相同密鑰的計量，則只會傳回具有最新時間戳的值。
如果有多個具有最新時間戳的值，則傳回這些值的最大值。
databricks experiments get-run RUN_ID [flags]
Arguments
RUN_ID
要擷取的運行標識碼。 必須提供 。
選項
--run-uuid string
已被取代，請改用 --run_id 。 要擷取的運行標識碼。
databricks 實驗中 list-artifacts
列出一次執行的工件。 可選擇性地指定 artifact_path 的前綴，如果有指定，回應只會包含具有指定前綴的工件。 在 Unity Catalog 磁碟區中，最多可擷取 1000 個工件。 使用 databricks fs ls 來列出 Unity Catalog 磁碟區中的項目，此功能支援分頁。
databricks experiments list-artifacts [flags]
Arguments
None
選項
--page-token string
表示要擷取工件結果頁碼的參數。
--path string
篩選符合此路徑的工件（根工件目錄的相對路徑）。
--run-id string
要列出其成品的執行標識碼。
--run-uuid string
已被取代，請改用 --run_id 。 要列出其成品的執行標識碼。
databricks 實驗列表 list-experiments
取得所有實驗的清單。
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 字串或 @path 整合至包含要求內容的 JSON 檔案。
--run-id string
要登入的執行標識碼。
Databricks 實驗中記錄輸入參數
Important
此命令是實驗性的。
將數據集、模型等輸入記錄到 MLflow 的運行實例中。
databricks experiments log-inputs RUN_ID [flags]
Arguments
RUN_ID
要登入的執行標識碼
選項
--json JSON
內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。
Databricks 實驗 log-logged-model-params
Log 參數用於記錄模型。 參數是鍵-值對（字串鍵、字串值）。 對於已記錄的模型，一個參數只能記錄一次;嘗試用不同值覆蓋現有參數會回傳錯誤。
databricks experiments log-logged-model-params MODEL_ID [flags]
Arguments
MODEL_ID
要記錄參數的模型 ID。
選項
--json JSON
內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。
Examples
以下範例記錄了已記錄模型的參數：
databricks experiments log-logged-model-params m-1234567890abcdef --json '{"params": [{"key": "learning_rate", "value": "0.01"}]}'
databricks 實驗記錄計量
記錄運行的度量。 計量是具有相關聯時間戳的索引鍵/值組（字串索引鍵、浮點數）。 範例包括代表 ML 模型精確度的各種計量。 計量可以記錄多次。
databricks experiments log-metric KEY VALUE TIMESTAMP [flags]
Arguments
KEY
計量的名稱。
VALUE
被記錄的度量的雙精度數值。
TIMESTAMP
記錄計量時，Unix 時間戳以毫秒為單位。
選項
--dataset-digest string
與指標相關聯的數據集摘要，例如
--dataset-name string
與計量相關聯的數據集名稱。
--json JSON
內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。
--model-id string
如果適用，則為與度量相關聯的已記錄模型識別碼。
--run-id string
要在其中記錄計量的執行標識碼。
--run-uuid string
已被取代，請改用 --run_id 。 要在其中記錄計量的執行標識碼。
--step int
記錄指標的步驟。
databricks 實驗日誌模型
記錄模型。
Important
此命令是實驗性的。
databricks experiments log-model [flags]
Arguments
None
選項
--json JSON
內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。
--model-json string
JSON 格式的 MLmodel 檔案。
--run-id string
要登入的執行標識碼。
Databricks 實驗的日誌輸出
日誌輸出，例如MLflow執行的模型。
databricks experiments log-outputs RUN_ID [flags]
Arguments
RUN_ID
記錄輸出的執行編號。
選項
--json JSON
內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。
Examples
以下範例記錄執行時的輸出：
databricks experiments log-outputs abc123def456 --json '{"logged_models": [{"model_id": "m-1234567890abcdef"}]}'
databricks 實驗 記錄參數
記錄用於運行的參數。 參數是鍵-值對（字串鍵、字串值）。 範例包括用於 ML 模型定型的超參數，以及 ETL 管線中使用的常數日期和值。 某個參數在每次執行中只能被記錄一次。
databricks experiments log-param KEY VALUE [flags]
Arguments
KEY
參數的名稱。 大小上限為 255 個字節。
VALUE
所記錄之參數的字串值。 大小上限為 500 個字節。
選項
--json JSON
內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。
--run-id string
要記錄參數的執行過程ID。
--run-uuid string
[已被取代，請改用 run_id]要記錄參數的執行標識碼。
databricks 實驗 `restore-experiment`
還原標示要刪除的實驗。 這也會還原相關聯的元數據、執行、計量、參數和標記。 如果實驗使用 FileStore，將還原與實驗相關聯的基礎工件。
如果實驗從未建立或已永久刪除，則拋出RESOURCE_DOES_NOT_EXIST。
databricks experiments restore-experiment EXPERIMENT_ID [flags]
Arguments
EXPERIMENT_ID
相關聯實驗的標識碼。
選項
--json JSON
內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。
databricks 實驗恢復執行
還原已刪除的執行。 這也會還原相關聯的元數據、執行、計量、參數和標記。
如果程式執行從未建立或是已經永久刪除，則會拋出RESOURCE_DOES_NOT_EXIST異常。
databricks experiments restore-run RUN_ID [flags]
Arguments
RUN_ID
要還原的運行 ID。
選項
--json JSON
內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。
databricks 實驗還原執行記錄
批次還原會在實驗中運行，其刪除操作不早於指定的時間戳。 每次要求最多還原 max_runs。
databricks experiments restore-runs EXPERIMENT_ID MIN_TIMESTAMP_MILLIS [flags]
Arguments
EXPERIMENT_ID
包含要恢復的執行項目之實驗ID。
MIN_TIMESTAMP_MILLIS
自 UNIX epoch 起以毫秒為單位計算的還原操作的最小刪除時間戳記。 只有在此時間戳之後刪除的執行才會被還原。
選項
--json JSON
內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。
--max-runs int
可選的正整數，表示要復原的執行次數的最大數目。
databricks 實驗搜尋
搜尋符合指定搜尋準則的實驗。
databricks experiments search-experiments [flags]
Arguments
None
選項
--filter string
代表 SQL 篩選條件的字串
--json JSON
內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。
--max-results int
所需的實驗數目上限。
--page-token string
標記，指出要擷取之實驗的頁面。
--view-type ViewType
要傳回之實驗類型的限定符。 支援的值：ACTIVE_ONLY、ALL、DELETED_ONLY
Databricks 實驗搜尋記錄模型
搜尋符合特定搜尋條件的已記錄模型。
databricks experiments search-logged-models [flags]
選項
--filter string
一個過濾式，涵蓋已記錄的模型資訊與資料，回傳部分已記錄模型子集。
--json JSON
內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。
--max-results int
最多可歸還的登記模型數量。
--page-token string
標記指示要擷取的已記錄模型頁面。
Examples
以下範例搜尋實驗中已記錄的模型：
databricks experiments search-logged-models --filter 'experiment_id = "123456789"' --max-results 10
databricks 實驗搜尋運行
搜尋符合表達式的運行。 搜尋表達式可以使用 mlflowMetric 和 mlflowParam 索引鍵。
databricks experiments search-runs [flags]
Arguments
None
選項
--filter string
一個用於參數、度量和標籤的篩選表達式，用於傳回執行的子集。
--json JSON
內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。
--max-results int
期望的執行次數上限。
--page-token string
針對目前執行紀錄頁面的標記。
--run-view-type ViewType
是否只顯示啟用中的、已刪除的或所有的執行紀錄。 支援的值：ACTIVE_ONLY、ALL、DELETED_ONLY
databricks 實驗 設定實驗標籤
添加標籤於實驗中。 實驗標籤是可以更新的元數據。
databricks experiments set-experiment-tag EXPERIMENT_ID KEY VALUE [flags]
Arguments
EXPERIMENT_ID
用於記錄標籤的實驗標識碼。 必須提供 。
KEY
標記的名稱。 支援大小上限為 250 個字節的鍵。
VALUE
要記錄之標記的字串值。 支援大小上限為 64KB 的值。
選項
--json JSON
內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。
Databricks 實驗 set-logged-model-tags
為已記錄的模型設定標籤。
databricks experiments set-logged-model-tags MODEL_ID [flags]
Arguments
MODEL_ID
用來設定標籤的 Log 模型 ID。
選項
--json JSON
內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。
Examples
以下範例在已記錄的模型上設定標籤：
databricks experiments set-logged-model-tags m-1234567890abcdef --json '{"tags": [{"key": "stage", "value": "production"}]}'
databricks 實驗設定標籤
設定執行過程中的標籤。 標記是可在執行期間和執行完成之後更新的執行元數據。
databricks experiments set-tag KEY VALUE [flags]
Arguments
KEY
標記的名稱。 支援大小上限為 250 個字節的鍵。
VALUE
要記錄之標記的字串值。 支援大小上限為 64KB 的值。
選項
--json JSON
內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。
--run-id string
要記錄標籤的執行 ID。
--run-uuid string
已被取代，請改用 --run_id 。 要記錄標籤的執行 ID。
databricks 實驗功能 update-experiment
更新實驗。
databricks experiments update-experiment EXPERIMENT_ID [flags]
Arguments
EXPERIMENT_ID
相關聯實驗的標識碼。
選項
--json JSON
內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。
--new-name string
如果提供，實驗的名稱會變更為新的名稱。
databricks 實驗更新-執行
更新程序運行。
databricks experiments update-run [flags]
Arguments
None
選項
--end-time int
執行結束時的 Unix 時間戳，以毫秒為單位。
--json JSON
內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。
--run-id string
要更新的執行標識碼。
--run-name string
已更新執行的名稱。
--run-uuid string
已被取代，請改用 --run_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 實驗權限
設定實驗許可權。
設定物件的許可權，若已有許可權則予以取代。 如果未指定任何許可權，則刪除所有直接許可權。 物件可以從其根對象繼承許可權。
databricks experiments set-permissions EXPERIMENT_ID [flags]
Arguments
EXPERIMENT_ID
要取得或管理許可權的實驗。
選項
--json JSON
內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。
databricks 實驗更新許可權
更新實驗許可權。 實驗可以從其根對象繼承許可權。
databricks experiments update-permissions EXPERIMENT_ID [flags]
Arguments
EXPERIMENT_ID
要取得或管理許可權的實驗。
選項
--json JSON
內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。
全域旗標
--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、、appendinplace、 或json
-t, --target 字串
如果適用，要使用的套件組合目標