groupe de commandesmodel-registry
L'utilisation de Databricks CLI est soumise à la licence Databricks et à la politique de confidentialité Databricks, y compris toutes les dispositions relatives aux données d'utilisation.
Cette référence d'API documente les APIs pour le Workspace Model Registry. Databricks recommande d'utiliser les modèles dans Unity Catalog à la place. Les modèles d'Unity Catalog offrent une gouvernance centralisée des modèles, un accès entre les Workspace, une traçabilité et un déploiement. Le Workspace Model Registry sera déprécié à l'avenir.
Le groupe de commandes model-registry au sein de la CLI Databricks vous permet de gérer le cycle de vie complet des modèles MLflow. Le Workspace Model Registry est un repository de modèles centralisé, une interface utilisateur et un ensemble d'APIs qui vous permettent de gérer le cycle de vie complet des modèles MLflow.
databricks model-registry approve-transition-request
Approuver une demande de transition d'étape de version de modèle.
databricks model-registry approve-transition-request NAME VERSION STAGE ARCHIVE_EXISTING_VERSIONS [flags]
Arguments
NAME
Nom du modèle.
VERSION
Version du modèle.
STAGE
Étape cible de la transition. Valeurs prises en charge : Archived, None, Production, Staging
ARCHIVE_EXISTING_VERSIONS
Spécifie s'il faut archiver toutes les versions de modèle actuelles dans l'étape cible.
Options
--comment string
Commentaire fourni par l'utilisateur sur l'action.
--json JSON
La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.
databricks model-registry create-comment
Publier un commentaire sur une version de modèle. Un commentaire peut être soumis soit par un utilisateur, soit par programmation, pour afficher des informations pertinentes sur le modèle. Par exemple, des résultats de test ou des erreurs de déploiement.
databricks model-registry create-comment NAME VERSION COMMENT [flags]
Arguments
NAME
Nom du modèle.
VERSION
Version du modèle.
COMMENT
Commentaire fourni par l'utilisateur sur l'action.
Options
--json JSON
La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.
databricks registre-de-modèles créer-modèle
Créez un nouveau modèle enregistré avec le nom spécifié dans le corps de la requête.
Lance RESOURCE_ALREADY_EXISTS si un modèle enregistré portant le nom donné existe.
databricks model-registry create-model NAME [flags]
Arguments
NAME
Enregistrer les modèles sous ce nom
Options
--description string
Description facultative pour le modèle enregistré.
--json JSON
La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.
databricks model-registry create-model-version
Créer une version de modèle.
databricks model-registry create-model-version NAME SOURCE [flags]
Arguments
NAME
Enregistrez le modèle sous ce nom
SOURCE
URI indiquant l'emplacement des artefacts du modèle.
Options
--description string
Description facultative pour la version du modèle.
--json JSON
La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.
--run-id string
ID d'exécution MLflow pour la corrélation, si la source a été générée par une exécution d'Expérimentation dans le serveur de suivi MLflow.
--run-link string
Link d'exécution MLflow - il s'agit du Link exact de l'exécution qui a généré cette version du modèle, potentiellement hébergé sur une autre instance de MLflow.
databricks model-registry create-transition-request
Créer une demande de transition d'étape de version de modèle.
databricks model-registry create-transition-request NAME VERSION STAGE [flags]
Arguments
NAME
Nom du modèle.
VERSION
Version du modèle.
STAGE
Étape cible de la transition. Les valeurs valides sont :
- Aucun : l’étape initiale d’une version de modèle.
- Pré-production : Étape de pré-production.
- Production : Étape de production.
- Archivé : étape Archivée.
Valeurs prises en charge : [Archivé, Aucun, Production, Préproduction]
Options
--comment string
Commentaire fourni par l'utilisateur sur l'action.
--json JSON
La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.
databricks model-registry create-webhook
Cette commande est en Public Preview.
Créer un webhook de registre.
databricks model-registry create-webhook [flags]
Arguments
Aucun
Options
--description string
Description spécifiée par l'utilisateur pour le webhook.
--json JSON
La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.
--model-name string
Nom du modèle dont les événements déclencheraient ce webhook.
--status RegistryWebhookStatus
Activer ou désactiver le Trigger du webhook, ou mettre le webhook en mode test. Valeurs prises en charge : [ACTIVE, DISABLED, TEST_MODE]
Databricks registre de modèles supprimer un commentaire
Supprimer un commentaire sur une version de modèle.
databricks model-registry delete-comment ID [flags]
Arguments
ID
Identifiant unique du commentaire à supprimer.
Options
databricks model-registry delete-model
Supprimer un modèle enregistré.
databricks model-registry delete-model NAME [flags]
Arguments
NAME
Identifiant de nom unique du modèle enregistré.
Options
databricks model-registry delete-model-tag
Supprimer le tag pour un modèle enregistré.
databricks model-registry delete-model-tag NAME KEY [flags]
Arguments
NAME
Nom du modèle enregistré sous lequel le tag a été enregistré.
KEY
Nom du tag. Le nom doit être une correspondance exacte ; la suppression par caractère générique n'est pas prise en charge. La taille maximale est de 250 octets.
Options
databricks model-registry delete-model-version
Supprimer une version de modèle.
databricks model-registry delete-model-version NAME VERSION [flags]
Arguments
NAME
Nom du modèle enregistré
VERSION
Numéro de version du modèle
Options
databricks model-registry delete-model-version-tag
Supprimer un tag de version de modèle.
databricks model-registry delete-model-version-tag NAME VERSION KEY [flags]
Arguments
NAME
Nom du modèle enregistré sous lequel le tag a été enregistré.
VERSION
Numéro de version du modèle sous lequel le tag a été enregistré.
KEY
Nom du tag. Le nom doit être une correspondance exacte ; la suppression par caractère générique n'est pas prise en charge. La taille maximale est de 250 octets.
Options
databricks model-registry delete-transition-request
Annuler une demande de transition d'étape de version de modèle.
databricks model-registry delete-transition-request NAME VERSION STAGE CREATOR [flags]
Arguments
NAME
Nom du modèle.
VERSION
Version du modèle.
STAGE
Étape cible de la demande de transition. Les valeurs valides sont :
- Aucun : l’étape initiale d’une version de modèle.
- Pré-production : Étape de pré-production.
- Production : Étape de production.
- Archivé : étape Archivée.
Valeurs prises en charge : [Archivé, Aucun, Production, Préproduction]
CREATOR
Nom d'utilisateur de la personne ayant créé cette demande. Parmi les demandes de transition correspondant aux détails spécifiés, seule la transition créée par cet utilisateur sera supprimée.
Options
--comment string
Commentaire fourni par l'utilisateur sur l'action.
databricks model-registry delete-webhook
Cette commande est en Public Preview.
Supprime un webhook de registre.
databricks model-registry delete-webhook [flags]
Arguments
Aucun
Options
--id string
ID de webhook requis pour supprimer un webhook d'enregistrement.
databricks model-registry get-latest-versions
Obtenez la dernière version d'un modèle enregistré.
databricks model-registry get-latest-versions NAME [flags]
Arguments
NAME
Identifiant de nom unique du modèle enregistré.
Options
--json JSON
La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.
databricks model-registry get-model
Obtenir les détails d'un modèle. Il s'agit d'une version Databricks Workspace de l'Endpoint MLflow qui renvoie également l'ID du Workspace Databricks du modèle et le niveau d'autorisation de l'utilisateur demandeur sur le modèle.
databricks model-registry get-model NAME [flags]
Arguments
NAME
Identifiant de nom unique du modèle enregistré.
Options
databricks model-registry get-model-version
Obtenir une version de modèle.
databricks model-registry get-model-version NAME VERSION [flags]
Arguments
NAME
Nom du modèle enregistré
VERSION
Numéro de version du modèle
Options
databricks model-registry get-model-version-download-uri
Obtenir un URI pour download la version du modèle.
databricks model-registry get-model-version-download-uri NAME VERSION [flags]
Arguments
NAME
Nom du modèle enregistré
VERSION
Numéro de version du modèle
Options
databricks model-registry list-models
Listez tous les modèles enregistrés disponibles, dans la limite spécifiée dans max_results .
databricks model-registry list-models [flags]
Arguments
Aucun
Options
--max-results int
Nombre maximal de modèles enregistrés souhaité.
--page-token string
Jeton de pagination pour passer à la page suivante, basé sur une query précédente.
Databricks Registre des modèles list-transition-requests
Obtenez une liste de toutes les demandes de transition d'étape ouvertes pour la version du modèle.
databricks model-registry list-transition-requests NAME VERSION [flags]
Arguments
NAME
Nom du modèle.
VERSION
Version du modèle.
Options
databricks model-registry list-webhooks
Cette commande est en Public Preview.
Lister tous les webhooks du registre.
databricks model-registry list-webhooks [flags]
Arguments
Aucun
Options
--model-name string
Si non spécifié, tous les webhooks associés aux événements spécifiés sont répertoriés, quel que soit leur modèle associé.
--page-token string
Jeton indiquant la page des résultats d'artefact à récupérer.
databricks model-registry reject-transition-request
Rejeter une demande de transition d'étape de version de modèle.
databricks model-registry reject-transition-request NAME VERSION STAGE [flags]
Arguments
NAME
Nom du modèle.
VERSION
Version du modèle.
STAGE
Étape cible de la transition. Les valeurs valides sont :
- Aucun : l’étape initiale d’une version de modèle.
- Pré-production : Étape de pré-production.
- Production : Étape de production.
- Archivé : étape Archivée.
Valeurs prises en charge : [Archivé, Aucun, Production, Préproduction]
Options
--comment string
Commentaire fourni par l'utilisateur sur l'action.
--json JSON
La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.
databricks model-registry rename-model
Renommer un modèle enregistré.
databricks model-registry rename-model NAME [flags]
Arguments
NAME
Identifiant de nom unique du modèle enregistré.
Options
--json JSON
La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.
--new-name string
Si fourni, met à jour le nom de ce modèle enregistré.
databricks model-registry search-model-versions
Recherchez les versions de modèle spécifiques en fonction du **filtre** fourni.
databricks model-registry search-model-versions [flags]
Arguments
Aucun
Options
--filter string
Condition de filtre de chaîne, telle que « name='my-model-name' ».
--max-results int
Nombre maximal de modèles souhaités.
--page-token string
Jeton de pagination pour accéder à la page suivante basé sur la requête de recherche précédente.
databricks model-registry search-models
Recherchez les modèles enregistrés en fonction du **filtre** spécifié.
databricks model-registry search-models [flags]
Arguments
Aucun
Options
--filter string
Condition de filtre de chaîne, comme « name LIKE 'my-model-name' ».
--max-results int
Nombre maximal de modèles souhaités.
--page-token string
Jeton de pagination pour passer à la page suivante en fonction d'une query de recherche précédente.
databricks model-registry set-model-tag
Définissez un tag sur un modèle enregistré.
databricks model-registry set-model-tag NAME KEY VALUE [flags]
Arguments
NAME
Nom unique du modèle.
KEY
Nom du tag. La taille maximale dépend du backend de stockage. Si une balise portant ce nom existe déjà, sa valeur préexistante sera remplacée par la valeur spécifiée. Tous les backends de stockage sont garantis de prendre en charge des valeurs de clé allant jusqu'à 250 octets.
VALUE
Valeur de chaîne du tag journalisé. La taille maximale dépend du backend de stockage. Tous les backends de stockage garantissent la prise en charge des valeurs de clé d'une taille allant jusqu'à 5000 octets.
Options
--json JSON
La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.
databricks model-registry set-model-version-tag
Définir un tag de version de modèle.
databricks model-registry set-model-version-tag NAME VERSION KEY VALUE [flags]
Arguments
NAME
Nom unique du modèle.
VERSION
Numéro de version du modèle.
KEY
Nom du tag. La taille maximale dépend du backend de stockage. Si une balise portant ce nom existe déjà, sa valeur préexistante sera remplacée par la valeur spécifiée. Tous les backends de stockage sont garantis de prendre en charge des valeurs de clé allant jusqu'à 250 octets.
VALUE
Valeur de chaîne du tag journalisé. La taille maximale dépend du backend de stockage. Tous les backends de stockage garantissent la prise en charge des valeurs de clé d'une taille allant jusqu'à 5000 octets.
Options
--json JSON
La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.
databricks model-registry test-registry-webhook
Cette commande est en Public Preview.
Tester un webhook de registre.
databricks model-registry test-registry-webhook ID [flags]
Arguments
ID
Webhook ID
Options
--event RegistryWebhookEvent
Si l'événement est spécifié, le test Trigger utilise l'événement spécifié. Valeurs prises en charge : [ 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
La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.
databricks model-registry transition-stage
Faire évoluer le stade d'une version de modèle. Ceci est une version de workspace Databricks de l'endpoint MLflow qui accepte également un commentaire associé à la transition à enregistrer.
databricks model-registry transition-stage NAME VERSION STAGE ARCHIVE_EXISTING_VERSIONS [flags]
Arguments
NAME
Nom du modèle.
VERSION
Version du modèle.
STAGE
Étape cible de la transition. Les valeurs valides sont :
- Aucun : l’étape initiale d’une version de modèle.
- Pré-production : Étape de pré-production.
- Production : Étape de production.
- Archivé : étape Archivée.
Valeurs prises en charge : [Archivé, Aucun, Production, Préproduction]
ARCHIVE_EXISTING_VERSIONS
Spécifie s'il faut archiver toutes les versions de modèle actuelles dans l'étape cible.
Options
--comment string
Commentaire fourni par l'utilisateur sur l'action.
--json JSON
La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.
databricks model-registry update-comment
Publier une modification à un commentaire sur une version de modèle.
databricks model-registry update-comment ID COMMENT [flags]
Arguments
ID
Identifiant unique d'une activité
COMMENT
Commentaire fourni par l'utilisateur sur l'action.
Options
--json JSON
La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.
databricks model-registry update-model
Mettre à jour un modèle enregistré.
databricks model-registry update-model NAME [flags]
Arguments
NAME
Identifiant de nom unique du modèle enregistré.
Options
--description string
Si fourni, met à jour la description de ce registered_model.
--json JSON
La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.
databricks registre-de-modèles mettre-à-jour-version-modèle
Mettez à jour la version du modèle.
databricks model-registry update-model-version NAME VERSION [flags]
Arguments
NAME
Nom du modèle enregistré
VERSION
Numéro de version du modèle
Options
--description string
Si fourni, met à jour la description de ce registered_model.
--json JSON
La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.
databricks model-registry update-webhook
Cette commande est en Public Preview.
Mettre à jour un webhook de registre.
databricks model-registry update-webhook ID [flags]
Arguments
ID
Webhook ID
Options
--description string
Description spécifiée par l'utilisateur pour le webhook.
--json JSON
La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.
--status RegistryWebhookStatus
Activer ou désactiver le Trigger du webhook, ou mettre le webhook en mode test. Valeurs prises en charge : [ACTIVE, DISABLED, TEST_MODE]
databricks model-registry get-permission-levels
Obtenir les niveaux d'autorisation du modèle enregistré.
databricks model-registry get-permission-levels REGISTERED_MODEL_ID [flags]
Arguments
REGISTERED_MODEL_ID
Le modèle enregistré pour lequel obtenir ou gérer les permissions.
Options
databricks model-registry get-permissions
Obtient les permissions d'un modèle ajouté au registre. Les modèles enregistrés peuvent hériter des autorisations de leur objet racine.
databricks model-registry get-permissions REGISTERED_MODEL_ID [flags]
Arguments
REGISTERED_MODEL_ID
Le modèle enregistré pour lequel obtenir ou gérer les permissions.
Options
databricks model-registry set-permissions
Définissez les autorisations du modèle enregistré, en remplaçant les autorisations existantes si elles existent. Supprime toutes les autorisations directes si aucune n'est spécifiée. Les objets peuvent hériter des autorisations de leur objet racine.
databricks model-registry set-permissions REGISTERED_MODEL_ID [flags]
Arguments
REGISTERED_MODEL_ID
Le modèle enregistré pour lequel obtenir ou gérer les permissions.
Options
--json JSON
La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.
databricks model-registry update-permissions
Mettre à jour les permissions sur un modèle enregistré. Les modèles enregistrés peuvent hériter des autorisations de leur objet racine.
databricks model-registry update-permissions REGISTERED_MODEL_ID [flags]
Arguments
REGISTERED_MODEL_ID
Le modèle enregistré pour lequel obtenir ou gérer les permissions.
Options
--json JSON
La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.
Drapeaux globaux
--debug
Activer ou non la journalisation de débogage.
-h OU --help
Afficher l'aide de Databricks CLI ou du groupe de commandes associé ou de la commande associée.
--log-file chaîne
Une chaîne représentant le fichier dans lequel écrire les logs de sortie. Si cet indicateur n'est pas spécifié, la default est d'écrire les logs de sortie dans stderr.
--log-format Format
Le type de format de log, text ou json. La valeur par default est text.
--log-level chaîne
Une chaîne représentant le niveau de format du log. S'il n'est pas spécifié, le niveau de format du log est désactivé.
-o, --output Type
Le type de sortie de commande, text ou json. La valeur par default est text.
-p, --profile chaîne
Nom du profil dans le fichier ~/.databrickscfg à utiliser pour exécuter la commande. Si cet indicateur n'est pas spécifié, alors s'il existe, le profil nommé DEFAULT est utilisé.
--progress-format Format
Le format pour afficher les logs de progression : default, append, inplace ou json
-t, --target chaîne
Le cas échéant, la cible de bundle à utiliser