model-registry コマンド グループ

注記

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

注記

このAPIWorkspace Model RegistryにAPIsされたリファレンスです。Databricks では、代わりに Unity Catalog のモデル を使用することをお勧めします。Unity Catalog のモデルは、一元化されたモデル ガバナンス、クロスワークスペース アクセス、リネージ、およびデプロイを提供します。Workspace Model Registry は今後非推奨になります。

Databricks CLI 内の model-registry コマンド グループを使用すると、MLflow モデルのライフサイクル全体を管理できます。Workspace Model Registryは、一元化されたモデル・リポジトリーであり、MLflowモデルのライフサイクル全体を管理できるUIとAPIsセットです。

databricks model-registry approve-transition-request

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

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

引数

NAME

モデルの名前。

VERSION

モデルのバージョン。

STAGE

移行のターゲット ステージ。サポートされている値: Archived、 None、 Production、 Staging

ARCHIVE_EXISTING_VERSIONS

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

オプション

--comment string

アクションに対するユーザー提供のコメント。

--json JSON

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

グローバルフラグ

databricks model-registry create-comment

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

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

引数

NAME

モデルの名前。

VERSION

モデルのバージョン。

COMMENT

アクションに対するユーザー提供のコメント。

オプション

--json JSON

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

グローバルフラグ

databricks model-registry create-model

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

指定された名前の登録済みモデルが存在するかどうかをRESOURCE_ALREADY_EXISTSスローします。

databricks model-registry create-model NAME [flags]

引数

NAME

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

オプション

--description string

登録済みモデルの説明(オプション)。

--json JSON

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

グローバルフラグ

databricks model-registry create-model-version

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

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

引数

NAME

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

SOURCE

モデルアーティファクトの位置を示す URI。

オプション

--description string

モデルバージョンの説明(オプション)。

--json JSON

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

--run-id string

MLflow 相関の実行 ID (ソースがトラッキング サーバーでのエクスペリメント 実行によって生成された場合 MLflow 。

--run-link string

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

グローバルフラグ

databricks model-registry create-transition-request

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

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

引数

NAME

モデルの名前。

VERSION

モデルのバージョン。

STAGE

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

• なし: モデルバージョンの初期段階。
• ステージング:ステージングまたは本番運用前の段階。
• 本番運用: 本番運用 stage.
• アーカイブ済み: アーカイブ済みステージ。

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

オプション

--comment string

アクションに対するユーザー提供のコメント。

--json JSON

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

グローバルフラグ

databricks model-registry create-webhook

注記

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

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

databricks model-registry create-webhook [flags]

引数

なし

オプション

--description string

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

--json JSON

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

--model-name string

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

--status RegistryWebhookStatus

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

グローバルフラグ

databricks model-registry delete-comment

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

databricks model-registry delete-comment ID [flags]

引数

ID

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

オプション

グローバルフラグ

databricks model-registry delete-model

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

databricks model-registry delete-model NAME [flags]

引数

NAME

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

オプション

グローバルフラグ

databricks model-registry delete-model-tag

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

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

引数

NAME

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

KEY

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

オプション

グローバルフラグ

databricks model-registry delete-model-version

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

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

引数

NAME

登録したモデルの名前

VERSION

モデルのバージョン番号

オプション

グローバルフラグ

databricks model-registry delete-model-version-tag

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

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

引数

NAME

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

VERSION

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

KEY

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

オプション

グローバルフラグ

databricks model-registry delete-transition-request

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

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

引数

NAME

モデルの名前。

VERSION

モデルのバージョン。

STAGE

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

• なし: モデルバージョンの初期段階。
• ステージング:ステージングまたは本番運用前の段階。
• 本番運用: 本番運用 stage.
• アーカイブ済み: アーカイブ済みステージ。

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

CREATOR

この要求を作成したユーザーのユーザー名。指定された詳細に一致するトランジションリクエストのうち、このユーザーが作成した 1 つのトランジションのみが削除されます。

オプション

--comment string

アクションに対するユーザー提供のコメント。

グローバルフラグ

databricks model-registry delete-webhook

注記

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

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

databricks model-registry delete-webhook [flags]

引数

なし

オプション

--id string

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

グローバルフラグ

databricks model-registry get-latest-versions

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

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

引数

NAME

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

オプション

--json JSON

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

グローバルフラグ

databricks model-registry get-model

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

databricks model-registry get-model NAME [flags]

引数

NAME

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

オプション

グローバルフラグ

databricks model-registry get-model-version

モデルバージョンを入手します。

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

引数

NAME

登録したモデルの名前

VERSION

モデルのバージョン番号

オプション

グローバルフラグ

databricks model-registry get-model-version-download-uri

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

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

引数

NAME

登録したモデルの名前

VERSION

モデルのバージョン番号

オプション

グローバルフラグ

Databricks model-registry list-models

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

databricks model-registry list-models [flags]

引数

なし

オプション

--max-results int

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

--page-token string

ページネーショントークンを使用して、前のクエリに基づいて次のページに移動します。

グローバルフラグ

databricks model-registry list-transition-requests

モデル バージョンの開いているすべてのステージの移行要求のリストを取得します。

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

引数

NAME

モデルの名前。

VERSION

モデルのバージョン。

オプション

グローバルフラグ

databricks model-registry list-webhooks

注記

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

すべてのレジストリ Webhook を一覧表示します。

databricks model-registry list-webhooks [flags]

引数

なし

オプション

--model-name string

指定しない場合、関連付けられたモデルに関係なく、指定されたイベントに関連付けられているすべての Webhook が一覧表示されます。

--page-token string

フェッチするアーティファクト結果のページを示すトークン。

グローバルフラグ

databricks model-registry reject-transition-request

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

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

引数

NAME

モデルの名前。

VERSION

モデルのバージョン。

STAGE

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

• なし: モデルバージョンの初期段階。
• ステージング:ステージングまたは本番運用前の段階。
• 本番運用: 本番運用 stage.
• アーカイブ済み: アーカイブ済みステージ。

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

オプション

--comment string

アクションに対するユーザー提供のコメント。

--json JSON

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

グローバルフラグ

databricks model-registry rename-model

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

databricks model-registry rename-model NAME [flags]

引数

NAME

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

オプション

--json JSON

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

--new-name string

指定されている場合は、このregistered_modelの名前を更新します。

グローバルフラグ

databricks model-registry search-model-versions

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

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

引数

なし

オプション

--filter string

文字列フィルター条件 ("name='my-model-name'" など)。

--max-results int

必要なモデルの最大数。

--page-token string

ページネーショントークンを使用して、前の検索クエリに基づいて次のページに移動します。

グローバルフラグ

databricks model-registry search-models

指定した フィルター に基づいて登録済みモデルを検索します。

databricks model-registry search-models [flags]

引数

なし

オプション

--filter string

文字列フィルター条件 ("name LIKE 'my-model-name'" など)。

--max-results int

必要なモデルの最大数。

--page-token string

ページネーショントークンを使用して、前の検索クエリに基づいて次のページに移動します。

グローバルフラグ

databricks model-registry set-model-tag

登録したモデルにタグを設定します。

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

引数

NAME

モデルの一意の名前。

KEY

タグの名前。最大サイズは、ストレージバックエンドによって異なります。この名前のタグが既に存在する場合、その既存の値は指定された値に置き換えられます。すべてのストレージバックエンドは、最大 250 バイトのサイズのキー値をサポートすることが保証されています。

VALUE

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

オプション

--json JSON

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

グローバルフラグ

databricks model-registry set-model-version-tag

モデルバージョンタグを設定します。

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

引数

NAME

モデルの一意の名前。

VERSION

モデルのバージョン番号。

KEY

タグの名前。最大サイズは、ストレージバックエンドによって異なります。この名前のタグが既に存在する場合、その既存の値は指定された値に置き換えられます。すべてのストレージバックエンドは、最大 250 バイトのサイズのキー値をサポートすることが保証されています。

VALUE

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

オプション

--json JSON

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

グローバルフラグ

databricks model-registry test-registry-webhook

注記

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

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

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

引数

ID

Webhook ID

オプション

--event RegistryWebhookEvent

event が指定されている場合、テスト トリガーは指定されたイベントを使用します。サポートされている値: [ 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 model-registry transition-stage

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

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

引数

NAME

モデルの名前。

VERSION

モデルのバージョン。

STAGE

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

• なし: モデルバージョンの初期段階。
• ステージング:ステージングまたは本番運用前の段階。
• 本番運用: 本番運用 stage.
• アーカイブ済み: アーカイブ済みステージ。

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

ARCHIVE_EXISTING_VERSIONS

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

オプション

--comment string

アクションに対するユーザー提供のコメント。

--json JSON

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

グローバルフラグ

databricks model-registry update-comment

モデルバージョンのコメントに編集を投稿します。

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

引数

ID

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

COMMENT

アクションに対するユーザー提供のコメント。

オプション

--json JSON

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

グローバルフラグ

databricks model-registry update-model

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

databricks model-registry update-model NAME [flags]

引数

NAME

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

オプション

--description string

指定されている場合は、このregistered_modelの説明を更新します。

--json JSON

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

グローバルフラグ

databricks model-registry update-model-version

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

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

引数

NAME

登録したモデルの名前

VERSION

モデルのバージョン番号

オプション

--description string

指定されている場合は、このregistered_modelの説明を更新します。

--json JSON

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

グローバルフラグ

databricks model-registry update-webhook

注記

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

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

databricks model-registry update-webhook ID [flags]

引数

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]

引数

REGISTERED_MODEL_ID

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

オプション

グローバルフラグ

databricks model-registry get-permissions

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

databricks model-registry get-permissions REGISTERED_MODEL_ID [flags]

引数

REGISTERED_MODEL_ID

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

オプション

グローバルフラグ

databricks model-registry set-permissions

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

databricks model-registry set-permissions REGISTERED_MODEL_ID [flags]

引数

REGISTERED_MODEL_ID

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

オプション

--json JSON

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

グローバルフラグ

databricks model-registry update-permissions

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

databricks model-registry update-permissions REGISTERED_MODEL_ID [flags]

引数

REGISTERED_MODEL_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

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