次の方法で共有

model-registry コマンド グループ

Note

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

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

Note

この API リファレンスでは、ワークスペース モデル レジストリの API について説明します。 Databricks では、代わりに Unity カタログでモデル を使用することをお勧めします。 Unity Catalog のモデルでは、一元化されたモデル ガバナンス、クロスワークスペース アクセス、系列、デプロイが提供されています。 ワークスペース モデル レジストリは、今後非推奨となる予定です。

model-registry 内の コマンド グループを使用すると、MLflow モデルの完全なライフサイクルを管理できます。 ワークスペース モデル レジストリは、一元化されたモデル リポジトリであり、MLflow モデルの完全なライフサイクルを管理できる UI と API のセットです。

Databricks モデルレジストリの approve-transition-request を承認する

モデル バージョン ステージ移行要求を承認します。

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

Arguments

NAME

    モデルの名前。

VERSION

    モデルのバージョン。

STAGE

    移行の目標段階。 サポートされている値: Archived、None、Production、Staging

ARCHIVE_EXISTING_VERSIONS

    ターゲット ステージ内のすべての現在のモデル バージョンをアーカイブするかどうかを指定します。

オプション

--comment string

    アクションに関するユーザー指定のコメント。

--json JSON

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

グローバル フラグ

databricks モデルレジストリ コメントを作成する

モデル バージョンに対してコメントを投稿する。 コメントは、ユーザーが送信することも、プログラムを使用してモデルに関する関連情報を表示することもできます。 たとえば、テスト結果やデプロイ エラーなどです。

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

Arguments

NAME

    モデルの名前。

VERSION

    モデルのバージョン。

COMMENT

    アクションに関するユーザー指定のコメント。

オプション

--json JSON

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

グローバル フラグ

Databricks モデル・レジストリでモデルを作成する

要求本文で指定された名前を使用して、新しい登録済みモデルを作成します。

指定した名前の登録済みモデルが存在する場合は、RESOURCE_ALREADY_EXISTS をスローします。

databricks model-registry create-model NAME [flags]

Arguments

NAME

    この名前でモデルを登録する

オプション

--description string

    登録済みモデルの説明 (省略可能)。

--json JSON

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

グローバル フラグ

databricks model-registry create-model-version

モデル バージョンを作成します。

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

Arguments

NAME

    この名前でモデルを登録する

SOURCE

    モデル成果物の場所を示す URI。

オプション

--description string

    モデル バージョンの説明 (省略可能)。

--json JSON

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

--run-id string

    MLflow 追跡サーバーで実験実行によってソースが生成された場合、関連付け用の MLflow 実行 ID。

--run-link string

    MLflow 実行リンク - これは、このモデル バージョンを生成した実行の正確なリンクであり、MLflow の別のインスタンスでホストされている可能性があります。

グローバル フラグ

databricksモデルレジストリ 移行リクエストを作成

モデル バージョン ステージ移行要求を作成します。

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

Arguments

NAME

    モデルの名前。

VERSION

    モデルのバージョン。

STAGE

    移行の目標段階。 有効な値は次のとおりです。

  • なし: モデル バージョンの初期段階。
  • ステージング: テスト段階または実稼働前段階。
  • 製品化: 製品化段階。
  • アーカイブ済み: ステージがアーカイブされました。

サポートされる値: [Archived,None, Production, Staging]

オプション

--comment string

    アクションに関するユーザー指定のコメント。

--json JSON

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

グローバル フラグ

databricks model-registry ウェブフックを作成

Note

このコマンドはパブリック プレビュー段階です。

レジストリ Webhook を作成します。

databricks model-registry create-webhook [flags]

Arguments

None

オプション

--description string

    Webhook のユーザー指定の説明。

--json JSON

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

--model-name string

    この Webhook をトリガーするイベントを持つモデルの名前。

--status RegistryWebhookStatus

    Webhook のトリガーを有効または無効にするか、Webhook をテスト モードにします。 サポートされている値: [ACTIVE、DISABLED、TEST_MODE]

グローバル フラグ

databricks モデルレジストリ コメント削除

モデル バージョンのコメントを削除します。

databricks model-registry delete-comment ID [flags]

Arguments

ID

    削除するコメントの一意識別子。

オプション

グローバル フラグ

databricks model-registry delete-model コマンドを使用してモデルを削除します。

登録済みモデルを削除します。

databricks model-registry delete-model NAME [flags]

Arguments

NAME

    登録済みモデルの一意の名前識別子。

オプション

グローバル フラグ

databricks model-registry モデルタグを削除

登録済みモデルのタグを削除します。

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

Arguments

NAME

    タグが記録された登録済みモデルの名前。

KEY

    タグの名前。 名前は完全に一致する必要があります。ワイルドカードの削除はサポートされていません。 最大サイズは 250 バイトです。

オプション

グローバル フラグ

databricks model-registryのdelete-model-versionコマンド

モデル バージョンを削除します。

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

Arguments

NAME

    登録済みモデルの名前

VERSION

    モデルのバージョン番号

オプション

グローバル フラグ

Databricksのモデルレジストリ内の特定のモデルバージョンタグを削除するコマンド（databricks model-registry delete-model-version-tag）

モデル バージョン タグを削除します。

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

Arguments

NAME

    タグが記録された登録済みモデルの名前。

VERSION

    タグがログに記録されたモデルバージョン番号。

KEY

    タグの名前。 名前は完全に一致する必要があります。ワイルドカードの削除はサポートされていません。 最大サイズは 250 バイトです。

オプション

グローバル フラグ

databricks モデルレジストリ 移行リクエスト削除

モデル バージョン ステージの移行要求を取り消します。

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

Arguments

NAME

    モデルの名前。

VERSION

    モデルのバージョン。

STAGE

    移行要求のターゲット ステージ。 有効な値は次のとおりです。

  • なし: モデル バージョンの初期段階。
  • ステージング: テスト段階または実稼働前段階。
  • 製品化: 製品化段階。
  • アーカイブ済み: ステージがアーカイブされました。

サポートされる値: [Archived,None, Production, Staging]

CREATOR

    この要求を作成したユーザーのユーザー名。 指定した詳細に一致する遷移要求のうち、このユーザーによって作成された 1 つの遷移のみが削除されます。

オプション

--comment string

    アクションに関するユーザー指定のコメント。

グローバル フラグ

databricks model-registry delete-webhook

Note

このコマンドはパブリック プレビュー段階です。

レジストリ Webhook を削除します。

databricks model-registry delete-webhook [flags]

Arguments

None

オプション

--id string

    レジストリ Webhook を削除するために必要な Webhook ID。

グローバル フラグ

databricks モデルレジストリ最新バージョン取得 (databricks model-registry get-latest-versions)

登録済みモデルの最新バージョンを取得します。

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

Arguments

NAME

    登録済みモデルの一意の名前識別子。

オプション

--json JSON

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

グローバル フラグ

databricks model-registry get-model

モデルの詳細を取得します。 これは、モデルの Databricks ワークスペース ID と、モデルに対する要求ユーザーのアクセス許可レベルも返す 、MLflow エンドポイント の Databricks ワークスペース バージョンです。

databricks model-registry get-model NAME [flags]

Arguments

NAME

    登録済みモデルの一意の名前識別子。

オプション

グローバル フラグ

databricks model-registry get-model-version

モデル バージョンを取得します。

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

Arguments

NAME

    登録済みモデルの名前

VERSION

    モデルのバージョン番号

オプション

グローバル フラグ

databricks model-registry get-model-version-download-uri（Databricksモデルレジストリで特定のモデルバージョンのダウンロードURIを取得するコマンド）

モデル バージョンをダウンロードするための URI を取得します。

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

Arguments

NAME

    登録済みモデルの名前

VERSION

    モデルのバージョン番号

オプション

グローバル フラグ

databricks model-registry list-models (モデルの一覧を表示)

max_results で指定されている制限まで、使用可能なすべての登録済みモデルを一覧表示します。

databricks model-registry list-models [flags]

Arguments

None

オプション

--max-results int

    必要な登録済みモデルの最大数。

--page-token string

    前のクエリに基づいて次のページに移動する改ページ トークン。

グローバル フラグ

databricks モデルレジストリ list-transition-requests (リスト遷移要求)

モデル バージョンのすべてのオープン ステージ移行要求の一覧を取得します。

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

Arguments

NAME

    モデルの名前。

VERSION

    モデルのバージョン。

オプション

グローバル フラグ

databricks model-registry list-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)

モデル バージョン ステージの移行要求を拒否します。

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

Arguments

NAME

    モデルの名前。

VERSION

    モデルのバージョン。

STAGE

    移行の目標段階。 有効な値は次のとおりです。

  • なし: モデル バージョンの初期段階。
  • ステージング: テスト段階または実稼働前段階。
  • 製品化: 製品化段階。
  • アーカイブ済み: ステージがアーカイブされました。

サポートされる値: [Archived,None, Production, Staging]

オプション

--comment string

    アクションに関するユーザー指定のコメント。

--json JSON

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

グローバル フラグ

Databricks モデルレジストリの rename-model コマンド

登録済みモデルの名前を変更します。

databricks model-registry rename-model NAME [flags]

Arguments

NAME

    登録済みモデルの一意の名前識別子。

オプション

--json JSON

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

--new-name string

    指定した場合は、このregistered_modelの名前を更新します。

グローバル フラグ

Databricks モデルレジストリ search-model-versions

指定されたフィルターに基づいて、特定のモデル バージョンを検索 します。

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

    ログに記録されるタグの文字列値。 最大サイズは、ストレージ バックエンドによって異なります。 すべてのストレージ バックエンドは、最大 5,000 バイトのサイズのキー値をサポートすることが保証されます。

オプション

--json JSON

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

グローバル フラグ

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

    ログに記録されるタグの文字列値。 最大サイズは、ストレージ バックエンドによって異なります。 すべてのストレージ バックエンドは、最大 5,000 バイトのサイズのキー値をサポートすることが保証されます。

オプション

--json JSON

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

グローバル フラグ

databricks モデルレジストリ テストレジストリウェブフック

Note

このコマンドはパブリック プレビュー段階です。

レジストリ Webhook をテストします。

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

Arguments

ID

    Webhook ID (ウェブフック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 ファイルに対するインライン JSON 文字列または @path。

グローバル フラグ

databricks モデルレジストリ トランジションステージ

モデル バージョンのステージを切り替えます。 これは、記録する遷移に関連付けられたコメントも受け入れる、Databricks ワークスペース バージョンの MLflow エンドポイント です。

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

Arguments

NAME

    モデルの名前。

VERSION

    モデルのバージョン。

STAGE

    移行の目標段階。 有効な値は次のとおりです。

  • なし: モデル バージョンの初期段階。
  • ステージング: テスト段階または実稼働前段階。
  • 製品化: 製品化段階。
  • アーカイブ済み: ステージがアーカイブされました。

サポートされる値: [Archived,None, Production, Staging]

ARCHIVE_EXISTING_VERSIONS

    ターゲット ステージ内のすべての現在のモデル バージョンをアーカイブするかどうかを指定します。

オプション

--comment string

    アクションに関するユーザー指定のコメント。

--json JSON

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

グローバル フラグ

databricksモデルレジストリのコメント更新

モデル バージョンのコメントに編集を行います。

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

Arguments

ID

    アクティビティの一意の識別子

COMMENT

    アクションに関するユーザー指定のコメント。

オプション

--json JSON

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

グローバル フラグ

databricks モデルレジストリ update-model

登録済みモデルを更新します。

databricks model-registry update-model NAME [flags]

Arguments

NAME

    登録済みモデルの一意の名前識別子。

オプション

--description string

    指定した場合は、このregistered_modelの説明を更新します。

--json JSON

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

グローバル フラグ

Databricks モデルレジストリのモデルバージョンを更新する

モデルのバージョンを更新します。

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

Arguments

NAME

    登録済みモデルの名前

VERSION

    モデルのバージョン番号

オプション

--description string

    指定した場合は、このregistered_modelの説明を更新します。

--json JSON

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

グローバル フラグ

databricks モデル・レジストリ アップデート・ウェブフック

Note

このコマンドはパブリック プレビュー段階です。

レジストリ Webhook を更新します。

databricks model-registry update-webhook ID [flags]

Arguments

ID

    Webhook ID

オプション

--description string

    Webhook のユーザー指定の説明。

--json JSON

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

--status RegistryWebhookStatus

    Webhook のトリガーを有効または無効にするか、Webhook をテスト モードにします。 サポートされている値: [ACTIVE、DISABLED、TEST_MODE]

グローバル フラグ

databricks model-registry get-permission-levels

登録済みのモデルのアクセス許可レベルを取得します。

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 model-registry set-permissions

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

databricks model-registry set-permissions REGISTERED_MODEL_ID [flags]

Arguments

REGISTERED_MODEL_ID

    アクセス許可を取得または管理する登録済みモデル。

オプション

--json JSON

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

グローバル フラグ

Databricks モデルレジストリの権限を更新する

登録済みモデルのアクセス許可を更新します。 登録済みモデルは、ルート オブジェクトからアクセス許可を継承できます。

databricks model-registry update-permissions REGISTERED_MODEL_ID [flags]

Arguments

REGISTERED_MODEL_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 文字列

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

  • Last updated on