Teilen über


model-registry Befehlsgruppe

Note

Diese Informationen gelten für Databricks CLI-Versionen 0.205 und höher. Die Databricks CLI befindet sich in der öffentlichen Vorschau.

Die Verwendung von Databricks CLI unterliegt der Datenbricks-Lizenz - und Databricks-Datenschutzerklärung, einschließlich der Bestimmungen zu Nutzungsdaten.

Note

Diese API-Referenz dokumentiert APIs für die Arbeitsbereichsmodellregistrierung. Databricks empfiehlt stattdessen die Verwendung von Modellen im Unity-Katalog . Modelle im Unity Catalog bieten zentralisierte Modellgovernance, arbeitsbereichsübergreifenden Zugriff, Datenherkunft und Bereitstellung. Die Arbeitsbereichsmodellregistrierung wird in Zukunft eingestellt.

Mit model-registry der Befehlsgruppe in der Databricks CLI können Sie den vollständigen Lebenszyklus von MLflow-Modellen verwalten. Die Arbeitsbereichsmodellregistrierung ist ein zentrales Modell-Repository und eine Benutzeroberfläche und eine Gruppe von APIs, mit denen Sie den vollständigen Lebenszyklus von MLflow-Modellen verwalten können.

Databricks Modellregister Genehmigung des Übergangsantrags

Genehmigen einer Modellversionsstufenübergangsanforderung.

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

Arguments

NAME

    Name des Modells.

VERSION

    Version des Modells.

STAGE

    Zielstufe des Übergangs. Unterstützte Werte: Archived, None, Production, Staging

ARCHIVE_EXISTING_VERSIONS

    Gibt an, ob alle aktuellen Modellversionen in der Zielstufe archiviert werden sollen.

Options

--comment string

    Vom Benutzer bereitgestellter Kommentar zur Aktion.

--json JSON

    Die inlinefähige JSON-Zeichenfolge oder die @path zur JSON-Datei mit dem Body der Anfrage.

Globale Kennzeichnungen

databricks Modell-Registrierung Kommentar-erstellen

Posten Sie einen Kommentar zu einer Modellversion. Ein Kommentar kann entweder von einem Benutzer oder programmgesteuert übermittelt werden, um relevante Informationen zum Modell anzuzeigen. Beispiel: Testergebnisse oder Bereitstellungsfehler.

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

Arguments

NAME

    Name des Modells.

VERSION

    Version des Modells.

COMMENT

    Vom Benutzer bereitgestellter Kommentar zur Aktion.

Options

--json JSON

    Die inlinefähige JSON-Zeichenfolge oder die @path zur JSON-Datei mit dem Body der Anfrage.

Globale Kennzeichnungen

Databricks Model Registry - Modell erstellen

Erstellen Sie ein neues registriertes Modell mit dem Namen, der im Anforderungstext angegeben ist.

Löst RESOURCE_ALREADY_EXISTS aus, wenn ein registriertes Modell mit dem angegebenen Namen vorhanden ist.

databricks model-registry create-model NAME [flags]

Arguments

NAME

    Registrieren von Modellen unter diesem Namen

Options

--description string

    Optionale Beschreibung für registriertes Modell.

--json JSON

    Die inlinefähige JSON-Zeichenfolge oder die @path zur JSON-Datei mit dem Body der Anfrage.

Globale Kennzeichnungen

databricks Modell-Registrierung Erstellen-Modell-Version

Erstellen Sie eine Modellversion.

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

Arguments

NAME

    Modell unter diesem Namen registrieren

SOURCE

    URI, der die Position der Modellartefakte angibt.

Options

--description string

    Optionale Beschreibung für die Modellversion.

--json JSON

    Die inlinefähige JSON-Zeichenfolge oder die @path zur JSON-Datei mit dem Body der Anfrage.

--run-id string

    MLflow Run-ID für die Korrelation, wenn die Quelle von einem im MLflow Tracking Server ausgeführten Experiment generiert wurde.

--run-link string

    MLflow-Ausführungslink – dies ist der genaue Link der Ausführung, die diese Modellversion generiert hat und möglicherweise in einer anderen Instanz von MLflow gehostet wird.

Globale Kennzeichnungen

databricks Model-Registry Erstellen-Übergangsanfrage

Erstellen Sie eine Modellversionsstufenübergangsanforderung.

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

Arguments

NAME

    Name des Modells.

VERSION

    Version des Modells.

STAGE

    Zielstufe des Übergangs. Gültige Werte sind:

  • Keine: Die erste Phase einer Modellversion.
  • Staging: Staging- oder Pre-Production-Phase.
  • Produktion: Produktionsphase.
  • Archiviert: Archivierte Stufe.

Unterstützte Werte: [Archiviert, Keine, Produktion, Staging]

Options

--comment string

    Vom Benutzer bereitgestellter Kommentar zur Aktion.

--json JSON

    Die inlinefähige JSON-Zeichenfolge oder die @path zur JSON-Datei mit dem Body der Anfrage.

Globale Kennzeichnungen

Databricks-Modell-Register Webhook-Erstellung

Note

Dieser Befehl befindet sich in der öffentlichen Vorschau.

Erstellen Sie einen Registrierungswebhook.

databricks model-registry create-webhook [flags]

Arguments

None

Options

--description string

    Vom Benutzer angegebene Beschreibung für den Webhook.

--json JSON

    Die inlinefähige JSON-Zeichenfolge oder die @path zur JSON-Datei mit dem Body der Anfrage.

--model-name string

    Name des Modells, dessen Ereignisse diesen Webhook auslösen würden.

--status RegistryWebhookStatus

    Aktivieren oder deaktivieren Sie das Auslösen des Webhooks, oder setzen Sie den Webhook in den Testmodus. Unterstützte Werte: [AKTIV, DEAKTIVIERT, TEST_MODUS]

Globale Kennzeichnungen

databricks model-registry Kommentar löschen

Löschen eines Kommentars zu einer Modellversion.

databricks model-registry delete-comment ID [flags]

Arguments

ID

    Eindeutiger Bezeichner des zu löschenden Kommentars.

Options

Globale Kennzeichnungen

Databricks Modell-Register Modell löschen

Löschen eines registrierten Modells.

databricks model-registry delete-model NAME [flags]

Arguments

NAME

    Eindeutiger Bezeichner des registrierten Modells.

Options

Globale Kennzeichnungen

databricks Modell-Register löschen-Modell-Tag

Löschen Sie das Etikett für ein registriertes Modell.

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

Arguments

NAME

    Name des registrierten Modells, unter dem der Tag protokolliert wurde.

KEY

    Name des Tags. Der Name muss genau übereinstimmen; das Löschen mit Platzhaltern wird nicht unterstützt. Die maximale Größe beträgt 250 Byte.

Options

Globale Kennzeichnungen

databricks model-registry lösche Modellversion

Löschen sie eine Modellversion.

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

Arguments

NAME

    Name des registrierten Modells

VERSION

    Modellversionsnummer

Options

Globale Kennzeichnungen

databricks model-registry delete-model-version-tag (lösche Modellversions-Tag)

Tag für eine Modellversion löschen.

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

Arguments

NAME

    Name des registrierten Modells, unter dem der Tag protokolliert wurde.

VERSION

    Versionsnummer des Modells, unter dem der Tag registriert wurde.

KEY

    Name des Tags. Der Name muss genau übereinstimmen; das Löschen mit Platzhaltern wird nicht unterstützt. Die maximale Größe beträgt 250 Byte.

Options

Globale Kennzeichnungen

databricks Modell-Registry Lösch-Übergangs-Anfrage

Abbrechen einer Übergangsanforderung für die Modellversionsphase.

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

Arguments

NAME

    Name des Modells.

VERSION

    Version des Modells.

STAGE

    Zielstufe der Übergangsanforderung. Gültige Werte sind:

  • Keine: Die erste Phase einer Modellversion.
  • Staging: Staging- oder Pre-Production-Phase.
  • Produktion: Produktionsphase.
  • Archiviert: Archivierte Stufe.

Unterstützte Werte: [Archiviert, Keine, Produktion, Staging]

CREATOR

    Benutzername des Benutzers, der diese Anforderung erstellt hat. Von den Übergangsanforderungen, die den angegebenen Details entsprechen, wird nur der von diesem Benutzer erstellte Übergang gelöscht.

Options

--comment string

    Vom Benutzer bereitgestellter Kommentar zur Aktion.

Globale Kennzeichnungen

databricks model-registry delete-webhook

Note

Dieser Befehl befindet sich in der öffentlichen Vorschau.

Löscht einen Registrierungswebhook.

databricks model-registry delete-webhook [flags]

Arguments

None

Options

--id string

    Webhook-ID erforderlich, um einen Registrierungswebhook zu löschen.

Globale Kennzeichnungen

databricks model-registry get-latest-versions

Rufen Sie die neueste Version eines registrierten Modells ab.

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

Arguments

NAME

    Eindeutiger Bezeichner des registrierten Modells.

Options

--json JSON

    Die inlinefähige JSON-Zeichenfolge oder die @path zur JSON-Datei mit dem Body der Anfrage.

Globale Kennzeichnungen

databricks model-registry get-model

Details zu einem Modell abrufen. Dies ist eine Databricks-Arbeitsbereichsversion des MLflow-Endpunkts , die auch die Databricks-Arbeitsbereichs-ID des Modells und die Berechtigungsstufe des anfordernden Benutzers im Modell zurückgibt.

databricks model-registry get-model NAME [flags]

Arguments

NAME

    Eindeutiger Bezeichner des registrierten Modells.

Options

Globale Kennzeichnungen

databricks model-registry get-model-version

Rufen Sie eine Modellversion ab.

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

Arguments

NAME

    Name des registrierten Modells

VERSION

    Modellversionsnummer

Options

Globale Kennzeichnungen

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

Ruft eine URI zum Herunterladen der Modellversion ab.

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

Arguments

NAME

    Name des registrierten Modells

VERSION

    Modellversionsnummer

Options

Globale Kennzeichnungen

databricks model-registry list-models

Listet alle verfügbaren registrierten Modelle bis zum in max_results angegebenen Grenzwert auf.

databricks model-registry list-models [flags]

Arguments

None

Options

--max-results int

    Maximale Anzahl registrierter Modelle gewünscht.

--page-token string

    Paginierungstoken, um basierend auf einer vorherigen Abfrage zur nächsten Seite zu wechseln.

Globale Kennzeichnungen

databricks model-registry list-transition-requests

Rufen Sie eine Liste aller offenen Übergangsanforderungen für die Modellversion ab.

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

Arguments

NAME

    Name des Modells.

VERSION

    Version des Modells.

Options

Globale Kennzeichnungen

Databricks-Modellregister Webhooks auflisten

Note

Dieser Befehl befindet sich in der öffentlichen Vorschau.

Alle Registrierungswebhooks auflisten.

databricks model-registry list-webhooks [flags]

Arguments

None

Options

--model-name string

    Wenn nicht angegeben, werden alle Webhooks aufgeführt, die den angegebenen Ereignissen zugeordnet sind, unabhängig von ihrem zugeordneten Modell.

--page-token string

    Token, das die Seite der abzurufenden Artefaktergebnisse angibt.

Globale Kennzeichnungen

databricks model-registry Ablehnungsanforderung für den Übergang

Ablehnen einer Modellversionsstufenübergangsanforderung.

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

Arguments

NAME

    Name des Modells.

VERSION

    Version des Modells.

STAGE

    Zielstufe des Übergangs. Gültige Werte sind:

  • Keine: Die erste Phase einer Modellversion.
  • Staging: Staging- oder Pre-Production-Phase.
  • Produktion: Produktionsphase.
  • Archiviert: Archivierte Stufe.

Unterstützte Werte: [Archiviert, Keine, Produktion, Staging]

Options

--comment string

    Vom Benutzer bereitgestellter Kommentar zur Aktion.

--json JSON

    Die inlinefähige JSON-Zeichenfolge oder die @path zur JSON-Datei mit dem Body der Anfrage.

Globale Kennzeichnungen

databricks model-registry rename-model

Benennen Sie ein registriertes Modell um.

databricks model-registry rename-model NAME [flags]

Arguments

NAME

    Eindeutiger Bezeichner des registrierten Modells.

Options

--json JSON

    Die inlinefähige JSON-Zeichenfolge oder die @path zur JSON-Datei mit dem Body der Anfrage.

--new-name string

    Aktualisiert, falls vorhanden, den Namen für dieses registered_model.

Globale Kennzeichnungen

databricks model-registry search-model-versions

Suchen Sie basierend auf dem angegebenen Filter nach bestimmten Modellversionen.

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

Arguments

None

Options

--filter string

    Zeichenfolge Filterbedingung, wie „name=‚mein-modell-name‘“.

--max-results int

    Maximale Anzahl der gewünschten Modelle.

--page-token string

    Paginierungstoken, um auf der Grundlage der vorherigen Suchabfrage zur nächsten Seite zu wechseln.

Globale Kennzeichnungen

databricks model-registry Modelle suchen

Suchen Sie basierend auf dem angegebenen Filter nach registrierten Modellen.

databricks model-registry search-models [flags]

Arguments

None

Options

--filter string

    Zeichenfolge Filterbedingung, z.B. „name LIKE ‚mein-modell-name‘“.

--max-results int

    Maximale Anzahl der gewünschten Modelle.

--page-token string

    Pagination-Token zum Navigieren auf die nächste Seite basierend auf einer vorherigen Suchanfrage.

Globale Kennzeichnungen

databricks model-registry set-model-tag

Legen Sie ein Label für ein registriertes Modell fest.

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

Arguments

NAME

    Eindeutiger Name des Modells.

KEY

    Name des Tags. Die maximale Größe hängt vom Speicher-Back-End ab. Wenn ein Tag mit diesem Namen bereits existiert, wird sein vorheriger Wert durch den angegebenen Wert ersetzt. Alle Speicher-Back-Ends unterstützen garantiert schlüsselwerte bis zu 250 Byte größe.

VALUE

    Zeichenfolgenwert des Tags, das protokolliert wird. Die maximale Größe hängt vom Speicher-Back-End ab. Alle Speicher-Back-Ends unterstützen garantiert schlüsselwerte bis zu 5000 Bytes größe.

Options

--json JSON

    Die inlinefähige JSON-Zeichenfolge oder die @path zur JSON-Datei mit dem Body der Anfrage.

Globale Kennzeichnungen

Databricks Modell-Registry Modellversions-Tag setzen

Legen Sie ein Modellversions-Tag fest.

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

Arguments

NAME

    Eindeutiger Name des Modells.

VERSION

    Modellversionsnummer.

KEY

    Name des Tags. Die maximale Größe hängt vom Speicher-Back-End ab. Wenn ein Tag mit diesem Namen bereits existiert, wird sein vorheriger Wert durch den angegebenen Wert ersetzt. Alle Speicher-Back-Ends unterstützen garantiert schlüsselwerte bis zu 250 Byte größe.

VALUE

    Zeichenfolgenwert des Tags, das protokolliert wird. Die maximale Größe hängt vom Speicher-Back-End ab. Alle Speicher-Back-Ends unterstützen garantiert schlüsselwerte bis zu 5000 Bytes größe.

Options

--json JSON

    Die inlinefähige JSON-Zeichenfolge oder die @path zur JSON-Datei mit dem Body der Anfrage.

Globale Kennzeichnungen

databricks model-registry test-registry-webhook

Note

Dieser Befehl befindet sich in der öffentlichen Vorschau.

Testen Sie einen Registrierungswebhook.

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

Arguments

ID

    Webhook-ID

Options

--event RegistryWebhookEvent

    Wenn das Ereignis angegeben ist, verwendet der Testtrigger das angegebene Ereignis. Unterstützte Werte: [ 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

    Die inlinefähige JSON-Zeichenfolge oder die @path zur JSON-Datei mit dem Body der Anfrage.

Globale Kennzeichnungen

Übergangsphase der Databricks-Modellregistrierung

Wechseln Sie die Phase einer Modellversion. Hierbei handelt es sich um eine Databricks-Arbeitsbereichsversion des MLflow-Endpunkts , die auch einen Kommentar akzeptiert, der dem zu erfassenden Übergang zugeordnet ist.

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

Arguments

NAME

    Name des Modells.

VERSION

    Version des Modells.

STAGE

    Zielstufe des Übergangs. Gültige Werte sind:

  • Keine: Die erste Phase einer Modellversion.
  • Staging: Staging- oder Pre-Production-Phase.
  • Produktion: Produktionsphase.
  • Archiviert: Archivierte Stufe.

Unterstützte Werte: [Archiviert, Keine, Produktion, Staging]

ARCHIVE_EXISTING_VERSIONS

    Gibt an, ob alle aktuellen Modellversionen in der Zielstufe archiviert werden sollen.

Options

--comment string

    Vom Benutzer bereitgestellter Kommentar zur Aktion.

--json JSON

    Die inlinefähige JSON-Zeichenfolge oder die @path zur JSON-Datei mit dem Body der Anfrage.

Globale Kennzeichnungen

Databricks Modell-Registry Kommentar-aktualisieren

Posten Sie eine Bearbeitung in einem Kommentar zu einer Modellversion.

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

Arguments

ID

    Eindeutiger Bezeichner einer Aktivität

COMMENT

    Vom Benutzer bereitgestellter Kommentar zur Aktion.

Options

--json JSON

    Die inlinefähige JSON-Zeichenfolge oder die @path zur JSON-Datei mit dem Body der Anfrage.

Globale Kennzeichnungen

databricks model-registry update-model

Aktualisieren eines registrierten Modells.

databricks model-registry update-model NAME [flags]

Arguments

NAME

    Eindeutiger Bezeichner des registrierten Modells.

Options

--description string

    Aktualisiert, falls vorhanden, die Beschreibung für dieses registered_model.

--json JSON

    Die inlinefähige JSON-Zeichenfolge oder die @path zur JSON-Datei mit dem Body der Anfrage.

Globale Kennzeichnungen

Databricks Modell-Register - Modellversion aktualisieren

Aktualisieren Sie die Modellversion.

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

Arguments

NAME

    Name des registrierten Modells

VERSION

    Modellversionsnummer

Options

--description string

    Aktualisiert, falls vorhanden, die Beschreibung für dieses registered_model.

--json JSON

    Die inlinefähige JSON-Zeichenfolge oder die @path zur JSON-Datei mit dem Body der Anfrage.

Globale Kennzeichnungen

databricks Modell-Registry Update-Webhook

Note

Dieser Befehl befindet sich in der öffentlichen Vorschau.

Aktualisieren eines Registrierungswebhooks.

databricks model-registry update-webhook ID [flags]

Arguments

ID

    Webhook-ID

Options

--description string

    Vom Benutzer angegebene Beschreibung für den Webhook.

--json JSON

    Die inlinefähige JSON-Zeichenfolge oder die @path zur JSON-Datei mit dem Body der Anfrage.

--status RegistryWebhookStatus

    Aktivieren oder deaktivieren Sie das Auslösen des Webhooks, oder setzen Sie den Webhook in den Testmodus. Unterstützte Werte: [AKTIV, DEAKTIVIERT, TEST_MODUS]

Globale Kennzeichnungen

databricks Modell-Registry Berechtigungsstufen abfragen

Rufen Sie Berechtigungsstufen des registrierten Modells ab.

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

Arguments

REGISTERED_MODEL_ID

    Das registrierte Modell, für das Berechtigungen abgerufen oder verwaltet werden sollen.

Options

Globale Kennzeichnungen

databricks Modellregister-Berechtigungen abrufen

Ruft die Berechtigungen eines registrierten Modells ab. Registrierte Modelle können Berechtigungen von ihrem Stammobjekt erben.

databricks model-registry get-permissions REGISTERED_MODEL_ID [flags]

Arguments

REGISTERED_MODEL_ID

    Das registrierte Modell, für das Berechtigungen abgerufen oder verwaltet werden sollen.

Options

Globale Kennzeichnungen

Databricks Model-Registry Set-Permissions

Legen Sie registrierte Modellberechtigungen fest, und ersetzen Sie ggf. vorhandene Berechtigungen. Löscht alle direkten Berechtigungen, wenn keine angegeben sind. Objekte können Berechtigungen vom Stammobjekt erben.

databricks model-registry set-permissions REGISTERED_MODEL_ID [flags]

Arguments

REGISTERED_MODEL_ID

    Das registrierte Modell, für das Berechtigungen abgerufen oder verwaltet werden sollen.

Options

--json JSON

    Die inlinefähige JSON-Zeichenfolge oder die @path zur JSON-Datei mit dem Body der Anfrage.

Globale Kennzeichnungen

Databricks Modell-Registry Zugriffsrechte aktualisieren

Aktualisieren Sie die Berechtigungen für ein registriertes Modell. Registrierte Modelle können Berechtigungen von ihrem Stammobjekt erben.

databricks model-registry update-permissions REGISTERED_MODEL_ID [flags]

Arguments

REGISTERED_MODEL_ID

    Das registrierte Modell, für das Berechtigungen abgerufen oder verwaltet werden sollen.

Options

--json JSON

    Die inlinefähige JSON-Zeichenfolge oder die @path zur JSON-Datei mit dem Body der Anfrage.

Globale Kennzeichnungen

Globale Kennzeichnungen

--debug

  Gibt an, ob die Debugprotokollierung aktiviert werden soll.

-h oder --help

    Hilfe für die Databricks CLI oder die zugehörige Befehlsgruppe oder den zugehörigen Befehl anzeigen.

--log-file Schnur

    Eine Zeichenfolge, die die Datei darstellt, in die Ausgabeprotokolle geschrieben werden sollen. Wenn dieses Flag nicht angegeben ist, werden Ausgabeprotokolle standardmäßig in stderr geschrieben.

--log-format Format

    Der Protokollformattyp text oder json. Der Standardwert ist text.

--log-level Schnur

    Eine Zeichenfolge, die die Protokollformatebene darstellt. Wenn nicht angegeben, ist die Protokollformatebene deaktiviert.

-o, --output Typ

    Der Befehlsausgabetyp text oder json. Der Standardwert ist text.

-p, --profile Schnur

    Der Name des Profils in der ~/.databrickscfg Datei, das zum Ausführen des Befehls verwendet werden soll. Wenn dieses Flag nicht angegeben wird, wird, falls vorhanden, das Profil mit dem Namen DEFAULT verwendet.

--progress-format Format

    Das Format zum Anzeigen von Statusprotokollen: default, , append, inplaceoder json

-t, --target Schnur

    Falls zutreffend, das zu verwendende Bündelziel