groupe de commandesregistered-models

remarque

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.

Le groupe de commandes registered-models dans le Databricks CLI contient des commandes pour gérer les modèles dans le registre de modèles dans Unity Catalog. Les modèles enregistrés fournissent un contrôle d'accès centralisé, un audit, une traçabilité et la découverte de modèles ML à travers les workspaces Databricks. Consultez Gérer le cycle de vie des modèles dans Unity Catalog.

databricks create-modèles-enregistrés

Créer un nouveau modèle enregistré dans Unity Catalog.

Le stockage des fichiers pour les versions de modèles dans le modèle enregistré sera situé à l'emplacement default spécifié par le schéma parent, le catalogue parent ou le métastore.

Pour que la création d'un modèle enregistré réussisse, l'utilisateur doit remplir les conditions suivantes :

• L'appelant doit être un administrateur de métastore, ou le propriétaire du catalogue et du schéma parents, ou disposer du privilège USE_CATALOG sur le catalogue parent et du privilège USE_SCHEMA sur le schéma parent.
• L'appelant doit disposer du privilège CREATE MODEL ou CREATE FUNCTION sur le schéma parent.

databricks registered-models create CATALOG_NAME SCHEMA_NAME NAME [flags]

Arguments

CATALOG_NAME

Le nom du catalogue où résident le schéma et le modèle enregistré.

SCHEMA_NAME

Le nom du schéma où se trouve le modèle enregistré.

NAME

Le nom du modèle enregistré.

Options

--comment string

Le commentaire joint au 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.

--storage-location string

L'emplacement de stockage sur le cloud sous lequel les fichiers de données des versions de modèle sont stockés.

Indicateurs globaux

Exemples

L'exemple suivant crée un modèle enregistré dans le catalogue et le schéma spécifiés :

Bash

databricks registered-models create main my_schema my_model

L’exemple suivant crée un modèle enregistré avec un commentaire :

Bash

databricks registered-models create main my_schema my_model --comment "My model description"

databricks registered-models delete

Supprimez un modèle enregistré et toutes ses versions de modèle du catalogue parent et du schéma spécifiés.

L'appelant doit être un administrateur de métastore ou un propriétaire du modèle enregistré. Dans ce dernier cas, l'appelant doit également être le propriétaire ou avoir le privilège USE_CATALOG sur le catalogue parent et le privilège USE_SCHEMA sur le schéma parent.

databricks registered-models delete FULL_NAME [flags]

Arguments

FULL_NAME

Le nom à trois niveaux (entièrement qualifié) du modèle enregistré.

Options

Indicateurs globaux

Exemples

L'exemple suivant supprime un modèle enregistré :

Bash

databricks registered-models delete main.my_schema.my_model

databricks registered-models delete-alias

Supprimer un alias de modèle enregistré.

L'appelant doit être un administrateur de métastore ou un propriétaire du modèle enregistré. Dans ce dernier cas, l'appelant doit également être le propriétaire ou avoir le privilège USE_CATALOG sur le catalogue parent et le privilège USE_SCHEMA sur le schéma parent.

databricks registered-models delete-alias FULL_NAME ALIAS [flags]

Arguments

FULL_NAME

Le nom à trois niveaux (entièrement qualifié) du modèle enregistré.

ALIAS

Le nom de l'alias.

Options

Indicateurs globaux

Exemples

L'exemple suivant supprime un alias de modèle enregistré :

Bash

databricks registered-models delete-alias main.my_schema.my_model production

databricks registered-models get

Obtenir un modèle enregistré.

L’appelant doit être un administrateur du métastore ou un propriétaire (ou disposer du privilège EXECUTE) du modèle enregistré. Dans ce dernier cas, l'appelant doit également être le propriétaire ou avoir le privilège USE_CATALOG sur le catalogue parent et le privilège USE_SCHEMA sur le schéma parent.

databricks registered-models get FULL_NAME [flags]

Arguments

FULL_NAME

Le nom à trois niveaux (entièrement qualifié) du modèle enregistré.

Options

--include-aliases

Inclure ou non les alias des modèles enregistrés dans la réponse.

--include-browse

Faut-il inclure les modèles enregistrés dans la réponse pour lesquels le principal ne peut accéder qu'à des métadonnées sélectives ?

Indicateurs globaux

Exemples

L'exemple suivant obtient des informations sur un modèle enregistré :

Bash

databricks registered-models get main.my_schema.my_model

L'exemple suivant fournit des informations sur un modèle enregistré, y compris les alias :

Bash

databricks registered-models get main.my_schema.my_model --include-aliases

databricks registered-models list

Lister les modèles enregistrés. Vous pouvez lister les modèles enregistrés sous un schéma particulier, ou lister tous les modèles enregistrés dans le metastore actuel.

Les modèles renvoyés sont filtrés en fonction des privilèges de l'utilisateur appelant. Par exemple, l'administrateur du metastore est en mesure de lister tous les modèles enregistrés. Un utilisateur standard doit être le propriétaire ou disposer du privilège EXECUTE sur le modèle enregistré pour recevoir les modèles enregistrés dans la réponse. Dans ce dernier cas, l'appelant doit également être le propriétaire ou avoir le privilège USE_CATALOG sur le catalogue parent et le privilège USE_SCHEMA sur le schéma parent.

Il n'y a aucune garantie d'un ordre spécifique des éléments dans la réponse.

databricks registered-models list [flags]

Options

--catalog-name string

L'identifiant du catalogue sous lequel lister les modèles enregistrés.

--include-browse

Faut-il inclure les modèles enregistrés dans la réponse pour lesquels le principal ne peut accéder qu'à des métadonnées sélectives ?

--max-results int

Nombre maximal de modèles enregistrés à renvoyer.

--page-token string

Jeton opaque à envoyer pour la page de résultats suivante (pagination).

--schema-name string

L'identifiant du schéma sous lequel lister les modèles enregistrés.

Indicateurs globaux

Exemples

L'exemple suivant répertorie tous les modèles enregistrés dans le métastore actuel :

Bash

databricks registered-models list

L'exemple suivant répertorie les modèles enregistrés dans un catalogue spécifique :

Bash

databricks registered-models list --catalog-name main

L'exemple suivant répertorie les modèles enregistrés dans un schéma spécifique :

Bash

databricks registered-models list --catalog-name main --schema-name my_schema

databricks registered-models set-alias

Définissez un alias sur le modèle enregistré spécifié.

L'appelant doit être un administrateur de métastore ou un propriétaire du modèle enregistré. Dans ce dernier cas, l'appelant doit également être le propriétaire ou avoir le privilège USE_CATALOG sur le catalogue parent et le privilège USE_SCHEMA sur le schéma parent.

databricks registered-models set-alias FULL_NAME ALIAS VERSION_NUM [flags]

Arguments

FULL_NAME

Nom complet du modèle enregistré.

ALIAS

Le nom de l'alias.

VERSION_NUM

Le numéro de version de la version du modèle vers laquelle pointe l'alias.

Options

--json JSON

La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.

Indicateurs globaux

Exemples

L'exemple suivant définit un alias sur un modèle enregistré :

Bash

databricks registered-models set-alias main.my_schema.my_model production 1

Mettre à jour les modèles enregistrés Databricks

Mettre à jour le modèle enregistré spécifié.

L'appelant doit être un administrateur de métastore ou un propriétaire du modèle enregistré. Dans ce dernier cas, l'appelant doit également être le propriétaire ou avoir le privilège USE_CATALOG sur le catalogue parent et le privilège USE_SCHEMA sur le schéma parent.

Actuellement, seuls le nom, le propriétaire ou le commentaire du modèle enregistré peuvent être mis à jour.

databricks registered-models update FULL_NAME [flags]

Arguments

FULL_NAME

Le nom à trois niveaux (entièrement qualifié) du modèle enregistré.

Options

--comment string

Le commentaire joint au 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.

``--new-name string`**

Nouveau nom pour le modèle enregistré.

--owner string

L'identifiant de l'utilisateur qui est propriétaire du modèle enregistré.

Indicateurs globaux

Exemples

L'exemple suivant met à jour le commentaire d'un modèle enregistré :

Bash

databricks registered-models update main.my_schema.my_model --comment "Updated model description"

L'exemple suivant met à jour le nom d'un modèle enregistré :

Bash

databricks registered-models update main.my_schema.my_model --new-name my_new_model

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