model-registry 命令群組

Note

此資訊適用於 Databricks CLI 版本 0.205 及以上。 Databricks CLI 處於 公開預覽狀態。

Databricks CLI 的使用受限於 Databricks 授權 和 Databricks 隱私權聲明，包括任何使用數據條款。

Note

此 API 參考文件記錄了工作區模型註冊表的 API。 Databricks 建議改 用 Unity 目錄中的模型 。 Unity 目錄中的模型提供集中式模型治理、跨工作區存取、譜系和部署。 工作區模型註冊表將會遭棄用。

model-registry Databricks CLI 中的指令群組允許您管理 MLflow 模型的完整生命週期。 工作區模型登錄是集中式模型存放庫和 UI 和一組 API，可讓您管理 MLflow 模型的完整生命週期。

Databricks 模型註冊表 approve-transition-request

核准模型版本階段轉換要求。

databricks model-registry approve-transition-request NAME VERSION STAGE ARCHIVE_EXISTING_VERSIONS [flags]

Arguments

NAME

    模型的名稱。

VERSION

    模型的版本。

STAGE

    轉換的目標階段。 支援的值：Archived、、None、 ProductionStaging

ARCHIVE_EXISTING_VERSIONS

    指定是否要封存目標階段中的所有目前模型版本。

選項

--comment string

    使用者提供的關於動作的評論。

--json JSON

    內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。

全域旗標

databricks model-registry 創建評論

在模型版本上張貼批注。 使用者或程序設計方式可以提交批注，以顯示模型的相關信息。 例如，測試結果或部署錯誤。

databricks model-registry create-comment NAME VERSION COMMENT [flags]

Arguments

NAME

    模型的名稱。

VERSION

    模型的版本。

COMMENT

    使用者提供的關於動作的評論。

選項

--json JSON

    內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。

全域旗標

Databricks 模型註冊表 create-model

使用要求主體中指定的名稱建立新的已註冊模型。

如果具有指定名稱的已註冊模型存在，則會擲回RESOURCE_ALREADY_EXISTS。

databricks model-registry create-model NAME [flags]

Arguments

NAME

    在這個名稱下註冊模型

選項

--description string

    已註冊模型的可選描述。

--json JSON

    內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。

全域旗標

Databricks 模型註冊表 新建模型版本

建立模型版本。

databricks model-registry create-model-version NAME SOURCE [flags]

Arguments

NAME

    將模型註冊為此名稱

SOURCE

    指出模型成品位置的 URI。

選項

--description string

    模型版本的可選描述。

--json JSON

    內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。

--run-id string

    MLflow 執行識別碼用於關聯性，如果來源是由在 MLflow 追蹤伺服器上執行的實驗生成的。

--run-link string

    MLflow 執行連結 - 這是產生此模型版本的該執行的確切連結，可能託管於 MLflow 的另一個實例。

全域旗標

Databricks 模型-登錄檔 建立-轉換-請求

建立模型版本階段轉換要求。

databricks model-registry create-transition-request NAME VERSION STAGE [flags]

Arguments

NAME

    模型的名稱。

VERSION

    模型的版本。

STAGE

    轉換的目標階段。 有效值為：

• 無：模型版本的初始階段。
• 預備：預備或生產前階段。
• 生產：生產階段。
• 封存：封存階段。

支援的值：[已封存、無、生產、預備]

選項

--comment string

    使用者提供的關於動作的評論。

--json JSON

    內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。

全域旗標

Databricks 模型-登錄檔建立-webhook

Note

此命令處於公開預覽狀態。

建立登錄 Webhook。

databricks model-registry create-webhook [flags]

Arguments

None

選項

--description string

    Webhook 的使用者指定描述。

--json JSON

    內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。

--model-name string

    事件會觸發此 Webhook 的模型名稱。

--status RegistryWebhookStatus

    啟用或停用觸發 Webhook，或讓 Webhook 進入測試模式。 支援的值：[啟用、停用、測試模式]

全域旗標

databricks 模型註冊表 刪除評論 (刪除模型註冊表中的評論)

刪除模型版本的批注。

databricks model-registry delete-comment ID [flags]

Arguments

ID

    要刪除之批注的唯一標識符。

選項

全域旗標

databricks 模型註冊表 刪除模型命令

刪除已註冊的模型。

databricks model-registry delete-model NAME [flags]

Arguments

NAME

    已註冊的模型唯一名稱標識碼。

選項

全域旗標

databricks model-registry delete-model-tag（刪除模型標籤）

刪除已註冊模型的標記。

databricks model-registry delete-model-tag NAME KEY [flags]

Arguments

NAME

    標籤在其下記錄的已註冊模型名稱。

KEY

    標記的名稱。 名稱必須是完全相符的;不支援刪除通配符。 大小上限為 250 個字節。

選項

全域旗標

databricks 模型註冊表 刪除模型版本

刪除模型版本。

databricks model-registry delete-model-version NAME VERSION [flags]

Arguments

NAME

    已註冊模型的名稱

VERSION

    模型版本號碼

選項

全域旗標

databricks 模型註冊表 刪除模型版本標籤

刪除模型版本標記。

databricks model-registry delete-model-version-tag NAME VERSION KEY [flags]

Arguments

NAME

    標籤在其下記錄的已註冊模型名稱。

VERSION

    該標籤所記錄的模型版本號碼。

KEY

    標記的名稱。 名稱必須是完全相符的;不支援刪除通配符。 大小上限為 250 個字節。

選項

全域旗標

databricks 模型註冊表刪除轉換請求 (delete-transition-request)

取消模型版本階段轉換要求。

databricks model-registry delete-transition-request NAME VERSION STAGE CREATOR [flags]

Arguments

NAME

    模型的名稱。

VERSION

    模型的版本。

STAGE

    轉換要求的目標階段。 有效值為：

• 無：模型版本的初始階段。
• 預備：預備或生產前階段。
• 生產：生產階段。
• 封存：封存階段。

支援的值：[已封存、無、生產、預備]

CREATOR

    建立此要求的用戶名稱。 在符合指定詳細數據的轉換要求中，只會刪除此使用者所建立的轉換。

選項

--comment string

    使用者提供的關於動作的評論。

全域旗標

Databricks 模型註冊表 delete-webhook（刪除網路鉤子）

Note

此命令處於公開預覽狀態。

刪除登錄 Webhook。

databricks model-registry delete-webhook [flags]

Arguments

None

選項

--id string

    刪除登錄 Webhook 所需的 Webhook 識別符。

全域旗標

Databricks 模型註冊表取得最新版本

取得已註冊模型的最新版本。

databricks model-registry get-latest-versions NAME [flags]

Arguments

NAME

    已註冊的模型唯一名稱標識碼。

選項

--json JSON

    內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。

全域旗標

Databricks model-registry get-model

取得模型的詳細數據。 這是 Databricks 工作空間版本的 MLflow 端點 ，同時回傳模型的 Databricks 工作空間 ID 以及請求使用者在模型上的權限等級。

databricks model-registry get-model NAME [flags]

Arguments

NAME

    已註冊的模型唯一名稱標識碼。

選項

全域旗標

databricks model-registry get-model-version（Databricks 模型註冊表 獲取模型版本）

取得模型版本。

databricks model-registry get-model-version NAME VERSION [flags]

Arguments

NAME

    已註冊模型的名稱

VERSION

    模型版本號碼

選項

全域旗標

Databricks 模型註冊表 get-model-version-download-uri

取得 URI 以下載模型版本。

databricks model-registry get-model-version-download-uri NAME VERSION [flags]

Arguments

NAME

    已註冊模型的名稱

VERSION

    模型版本號碼

選項

全域旗標

Databricks 上的命令: databricks model-registry list-models

列出所有可登記的車型，並限制在 max_results規定範圍內。

databricks model-registry list-models [flags]

Arguments

None

選項

--max-results int

    所需的已註冊模型數目上限。

--page-token string

    根據上一個查詢，分頁令牌可移至下一頁。

全域旗標

Databricks 模型註冊表列出轉換請求

取得模型版本的所有開放階段轉換要求清單。

databricks model-registry list-transition-requests NAME VERSION [flags]

Arguments

NAME

    模型的名稱。

VERSION

    模型的版本。

選項

全域旗標

databricks 模型註冊表 列出 webhooks

Note

此命令處於公開預覽狀態。

列出所有登錄 Webhook。

databricks model-registry list-webhooks [flags]

Arguments

None

選項

--model-name string

    若未進行指定，無論其相關模型是什麼，所有和指定事件相關的 Webhook 都會被列出。

--page-token string

    標記表示要擷取的工件結果頁面。

全域旗標

databricks 模型註冊表 拒絕轉換請求

拒絕模型版本階段轉換要求。

databricks model-registry reject-transition-request NAME VERSION STAGE [flags]

Arguments

NAME

    模型的名稱。

VERSION

    模型的版本。

STAGE

    轉換的目標階段。 有效值為：

• 無：模型版本的初始階段。
• 預備：預備或生產前階段。
• 生產：生產階段。
• 封存：封存階段。

支援的值：[已封存、無、生產、預備]

選項

--comment string

    使用者提供的關於動作的評論。

--json JSON

    內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。

全域旗標

databricks 模型註冊表 rename-model

重新命名已註冊的模型。

databricks model-registry rename-model NAME [flags]

Arguments

NAME

    已註冊的模型唯一名稱標識碼。

選項

--json JSON

    內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。

--new-name string

    如果提供，請更新此registered_model的名稱。

全域旗標

databricks 模型註冊表 搜尋模型版本

根據提供的 篩選器搜尋特定型號版本。

databricks model-registry search-model-versions [flags]

Arguments

None

選項

--filter string

    字串篩選條件，例如 "name='my-model-name'"。

--max-results int

    所需的模型數目上限。

--page-token string

    根據先前的搜尋查詢，分頁令牌可移至下一頁。

全域旗標

databricks 模型註冊表（model-registry）搜索模型（search-models）

根據指定的 篩選條件搜尋註冊型號。

databricks model-registry search-models [flags]

Arguments

None

選項

--filter string

    字串篩選條件，例如 「name LIKE 』my-model-name』」。。

--max-results int

    所需的模型數目上限。

--page-token string

    根據先前的搜尋查詢，分頁令牌可移至下一頁。

全域旗標

databricks 模型註冊表 set-model-tag

在已註冊的模型上設定標記。

databricks model-registry set-model-tag NAME KEY VALUE [flags]

Arguments

NAME

    模型的唯一名稱。

KEY

    標記的名稱。 大小上限取決於記憶體後端。 如果已有這個名稱的標籤存在，其預先存在的值將會由指定的值取代。 保證所有記憶體後端都支援大小上限為 250 位元組的索引鍵值。

VALUE

    要記錄之標記的字串值。 大小上限取決於記憶體後端。 所有儲存後端保證支援最多 5000 位元組的鍵值。

選項

--json JSON

    內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。

全域旗標

不變動英文命令: databricks model-registry set-model-version-tag (使用此命令來設置模型版本的標籤)

設定模型版本標記。

databricks model-registry set-model-version-tag NAME VERSION KEY VALUE [flags]

Arguments

NAME

    模型的唯一名稱。

VERSION

    模型版本號碼。

KEY

    標記的名稱。 大小上限取決於記憶體後端。 如果已有這個名稱的標籤存在，其預先存在的值將會由指定的值取代。 保證所有記憶體後端都支援大小上限為 250 位元組的索引鍵值。

VALUE

    要記錄之標記的字串值。 大小上限取決於記憶體後端。 所有儲存後端保證支援最多 5000 位元組的鍵值。

選項

--json JSON

    內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。

全域旗標

databricks 模型註冊表 測試註冊表 Webhook

Note

此命令處於公開預覽狀態。

測試登錄 Webhook。

databricks model-registry test-registry-webhook ID [flags]

Arguments

ID

    Webhook ID識別碼

選項

--event RegistryWebhookEvent

    如果指定事件，測試觸發程式會使用指定的事件。 支援的值為：[COMMENT_CREATED、MODEL_VERSION_CREATED、MODEL_VERSION_TAG_SET、MODEL_VERSION_TRANSITIONED_STAGE、MODEL_VERSION_TRANSITIONED_TO_ARCHIVED、MODEL_VERSION_TRANSITIONED_TO_PRODUCTION、MODEL_VERSION_TRANSITIONED_TO_STAGING、REGISTERED_MODEL_CREATED、TRANSITION_REQUEST_CREATED、TRANSITION_REQUEST_TO_ARCHIVED_CREATED、TRANSITION_REQUEST_TO_PRODUCTION_CREATED、TRANSITION_REQUEST_TO_STAGING_CREATED]

--json JSON

    內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。

全域旗標

Databricks 模型註冊表 過渡階段

更改模型版本的階段狀態。 這是 Databricks 工作區版本的 MLflow 端點，它可以接受並記錄與階段轉換相關的註解。

databricks model-registry transition-stage NAME VERSION STAGE ARCHIVE_EXISTING_VERSIONS [flags]

Arguments

NAME

    模型的名稱。

VERSION

    模型的版本。

STAGE

    轉換的目標階段。 有效值為：

• 無：模型版本的初始階段。
• 預備：預備或生產前階段。
• 生產：生產階段。
• 封存：封存階段。

支援的值：[已封存、無、生產、預備]

ARCHIVE_EXISTING_VERSIONS

    指定是否要封存目標階段中的所有目前模型版本。

選項

--comment string

    使用者提供的關於動作的評論。

--json JSON

    內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。

全域旗標

databricks 模型註冊 更新評論

將一個編輯發佈到模型版本的評論中。

databricks model-registry update-comment ID COMMENT [flags]

Arguments

ID

    活動的唯一標識碼

COMMENT

    使用者提供的關於動作的評論。

選項

--json JSON

    內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。

全域旗標

Databricks 模型註冊表更新模型

更新已註冊的模型。

databricks model-registry update-model NAME [flags]

Arguments

NAME

    已註冊的模型唯一名稱標識碼。

選項

--description string

    如果提供，請更新此registered_model的描述。

--json JSON

    內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。

全域旗標

Databricks 模型註冊表 更新模型版本

更新模型版本。

databricks model-registry update-model-version NAME VERSION [flags]

Arguments

NAME

    已註冊模型的名稱

VERSION

    模型版本號碼

選項

--description string

    如果提供，請更新此registered_model的描述。

--json JSON

    內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。

全域旗標

Databricks model-registry update-webhook

Note

此命令處於公開預覽狀態。

更新登錄 Webhook。

databricks model-registry update-webhook ID [flags]

Arguments

ID

    Webhook ID

選項

--description string

    Webhook 的使用者指定描述。

--json JSON

    內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。

--status RegistryWebhookStatus

    啟用或停用觸發 Webhook，或讓 Webhook 進入測試模式。 支援的值：[啟用、停用、測試模式]

全域旗標

databricks model-registry 取得權限層級

取得已註冊的模型許可權等級。

databricks model-registry get-permission-levels REGISTERED_MODEL_ID [flags]

Arguments

REGISTERED_MODEL_ID

    用於取得或管理權限的已註冊模型。

選項

全域旗標

databricks 模型註冊表 (model-registry) 取得權限 (get-permissions)

取得已註冊模型的權限。 已註冊的模型可以從其根對象繼承許可權。

databricks model-registry get-permissions REGISTERED_MODEL_ID [flags]

Arguments

REGISTERED_MODEL_ID

    用於取得或管理權限的已註冊模型。

選項

全域旗標

Databricks 模型註冊表 設定許可權

設定已註冊的模型許可權，如果現有許可權存在，則會取代現有的許可權。 如果未指定任何許可權，則刪除所有直接許可權。 物件可以從其根對象繼承許可權。

databricks model-registry set-permissions REGISTERED_MODEL_ID [flags]

Arguments

REGISTERED_MODEL_ID

    用於取得或管理權限的已註冊模型。

選項

--json JSON

    內嵌的 JSON 字串或 @path 整合至包含要求內容的 JSON 檔案。

全域旗標

databricks 模型註冊表 更新權限

更新已註冊模型的許可權。 已註冊的模型可以從其根對象繼承許可權。

databricks model-registry update-permissions REGISTERED_MODEL_ID [flags]

Arguments

REGISTERED_MODEL_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 字串

    如果適用，要使用的套件組合目標