registered-models コマンド グループ
この情報は、Databricks CLI バージョン 0.205 以降に適用されます。Databricks CLI は パブリック プレビュー段階です。
Databricks CLI 使用には、使用状況データを含む Databricks ライセンス および Databricks プライバシー通知が適用されます。
Databricks CLI内のregistered-modelsコマンドグループには、モデルレジストリのモデルを管理するコマンドUnity Catalogが含まれています。登録済みモデルは、一元化されたアクセス制御、監査、 リネージ、およびDatabricksワークスペース全体でMLモデルの検出を提供します。「 Unity Catalog でのモデル ライフサイクルの管理」を参照してください。
databricks registered-models create
Unity Catalog で新しい登録済みモデルを作成します。
登録済みモデル内のモデル バージョンのファイル ストレージは、親スキーマ、親カタログ、またはメタストアで指定された Default の場所に配置されます。
登録済みモデルの作成を成功させるには、ユーザーは次の条件を満たす必要があります。
- 呼び出し元は、メタストア管理者であるか、親カタログとスキーマの所有者であるか、親カタログに対する
USE_CATALOG特権と親スキーマに対するUSE_SCHEMA特権を持っている必要があります。 - 呼び出し元は、親スキーマに対する
CREATE MODELまたはCREATE FUNCTION権限を持っている必要があります。
databricks registered-models create CATALOG_NAME SCHEMA_NAME NAME [flags]
引数
CATALOG_NAME
スキーマと登録済みモデルが存在するカタログの名前。
SCHEMA_NAME
登録済みモデルが存在するスキーマの名前。
NAME
登録済みモデルの名前。
オプション
--comment string
登録したモデルに添付されたコメント。
--json JSON
インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。
--storage-location string
モデル バージョン データ ファイルが格納されるクラウド上の保存場所。
例
次の例では、指定したカタログとスキーマに登録済みモデルを作成します。
databricks registered-models create main my_schema my_model
次の例では、コメント付きの登録済みモデルを作成します。
databricks registered-models create main my_schema my_model --comment "My model description"
databricks registered-models delete
登録済みモデルとそのすべてのモデルバージョンを、指定した親カタログとスキーマから削除します。
呼び出し元は、メタストア管理者または登録済みモデルの所有者である必要があります。後者の場合、呼び出し元も所有者であるか、親カタログに対する USE_CATALOG 特権と親スキーマに対する USE_SCHEMA 特権を持っている必要があります。
databricks registered-models delete FULL_NAME [flags]
引数
FULL_NAME
登録済みモデルの 3 レベル (完全修飾) の名前。
オプション
例
次の例では、登録済みモデルを削除します。
databricks registered-models delete main.my_schema.my_model
databricks registered-models delete-alias
登録済みのモデル エイリアスを削除します。
呼び出し元は、メタストア管理者または登録済みモデルの所有者である必要があります。後者の場合、呼び出し元も所有者であるか、親カタログに対する USE_CATALOG 特権と親スキーマに対する USE_SCHEMA 特権を持っている必要があります。
databricks registered-models delete-alias FULL_NAME ALIAS [flags]
引数
FULL_NAME
登録済みモデルの 3 レベル (完全修飾) の名前。
ALIAS
エイリアスの名前。
オプション
例
次の例では、登録済みのモデル エイリアスを削除します。
databricks registered-models delete-alias main.my_schema.my_model production
databricks registered-models get
登録済みモデルを取得します。
呼び出し元は、メタストア管理者、または登録済みモデルの所有者 (または EXECUTE 特権を持っている) である必要があります。後者の場合、呼び出し元も所有者であるか、親カタログに対する USE_CATALOG 特権と親スキーマに対する USE_SCHEMA 特権を持っている必要があります。
databricks registered-models get FULL_NAME [flags]
引数
FULL_NAME
登録済みモデルの 3 レベル (完全修飾) の名前。
オプション
--include-aliases
登録済みモデル エイリアスを応答に含めるかどうか。
--include-browse
プリンシパルが選択的なメタデータにのみアクセスできるレスポンスに登録済みモデルを含めるかどうか。
例
次の例では、登録済みモデルに関する情報を取得します。
databricks registered-models get main.my_schema.my_model
次の例では、エイリアスを含む登録済みモデルに関する情報を取得します。
databricks registered-models get main.my_schema.my_model --include-aliases
databricks registered-models list
登録済みモデルを一覧表示します。特定のスキーマに登録されているモデルを一覧表示することも、現在のメタストアに登録されているすべてのモデルを一覧表示することもできます。
返されるモデルは、呼び出し元ユーザーの権限に基づいてフィルター処理されます。たとえば、メタストア管理者は、登録されているすべてのモデルを一覧表示できます。通常のユーザーは、登録済みモデルを応答で受信するには、所有者であるか、登録済みモデルに対する EXECUTE 権限を持っている必要があります。後者の場合、呼び出し元も所有者であるか、親カタログに対する USE_CATALOG 特権と親スキーマに対する USE_SCHEMA 特権を持っている必要があります。
応答内の要素の特定の順序を保証するものではありません。
databricks registered-models list [flags]
オプション
--catalog-name string
登録済みモデルを一覧表示するカタログの識別子。
--include-browse
プリンシパルが選択的なメタデータにのみアクセスできるレスポンスに登録済みモデルを含めるかどうか。
--max-results int
返す登録済みモデルの最大数。
--page-token string
結果の次のページ(ページネーション)に送信する不透明なトークン。
--schema-name string
登録済みモデルを一覧表示するスキーマの識別子。
例
次の例は、現在のメタストアに登録されているすべてのモデルの一覧です。
databricks registered-models list
次の例は、特定のカタログに登録されているモデルを一覧表示します。
databricks registered-models list --catalog-name main
次の例は、特定のスキーマに登録されているモデルをリストします。
databricks registered-models list --catalog-name main --schema-name my_schema
databricks registered-models set-alias
指定した登録済みモデルにエイリアスを設定します。
呼び出し元は、メタストア管理者または登録済みモデルの所有者である必要があります。後者の場合、呼び出し元も所有者であるか、親カタログに対する USE_CATALOG 特権と親スキーマに対する USE_SCHEMA 特権を持っている必要があります。
databricks registered-models set-alias FULL_NAME ALIAS VERSION_NUM [flags]
引数
FULL_NAME
登録モデルのフルネーム。
ALIAS
エイリアスの名前。
VERSION_NUM
エイリアスが指すモデル バージョンのバージョン番号。
オプション
--json JSON
インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。
例
次の例では、登録済みモデルにエイリアスを設定します。
databricks registered-models set-alias main.my_schema.my_model production 1
databricks registered-models update
指定した登録モデルを更新します。
呼び出し元は、メタストア管理者または登録済みモデルの所有者である必要があります。後者の場合、呼び出し元も所有者であるか、親カタログに対する USE_CATALOG 特権と親スキーマに対する USE_SCHEMA 特権を持っている必要があります。
現在、登録したモデルの名前、所有者、またはコメントのみを更新できます。
databricks registered-models update FULL_NAME [flags]
引数
FULL_NAME
登録済みモデルの 3 レベル (完全修飾) の名前。
オプション
--comment string
登録したモデルに添付されたコメント。
--json JSON
インライン JSON 文字列、またはリクエスト本文を含む JSON ファイルへの@path。
''--新しい名前の文字列'**
登録したモデルの新しい名前。
--owner string
登録済みモデルを所有するユーザーの識別子。
例
次の例では、登録済みモデルのコメントを更新します。
databricks registered-models update main.my_schema.my_model --comment "Updated model description"
次の例では、登録済みモデルの名前を更新します。
databricks registered-models update main.my_schema.my_model --new-name my_new_model
グローバルフラグ
--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
該当する場合は、使用するバンドル・ターゲット