Partager via


experiments groupe de commande

Note

Ces informations s’appliquent à Databricks CLI versions 0.205 et ultérieures. L’interface CLI Databricks est en préversion publique.

L’utilisation de l’interface CLI Databricks est soumise à la licence Databricks et à la notification de confidentialité Databricks, y compris les dispositions relatives aux données d’utilisation.

Le experiments groupe de commandes dans l’interface CLI Databricks vous permet de créer, modifier, supprimer et gérer des expériences dans MLflow. Consultez Organiser des exécutions de formation avec des expériences MLflow.

expériences databricks create-experiment

Créez une expérience avec un nom. Retourne l’ID de l’expérience nouvellement créée. Vérifie qu’une autre expérience portant le même nom n’existe pas déjà et échoue si une autre expérience portant le même nom existe déjà.

Lève RESOURCE_ALREADY_EXISTS si une expérience portant le nom donné existe déjà.

databricks experiments create-experiment NAME [flags]

Arguments

NAME

    Nom de l’expérience.

Options

--artifact-location string

    Emplacement où tous les artefacts de l’expérience sont stockés.

--json JSON

    Chaîne JSON inline ou chemin @path vers le fichier JSON avec le corps de la requête.

Indicateurs globaux

expériences de Databricks créer-exécution

Crée une nouvelle exécution dans une expérience. Un 'run' est généralement une seule exécution d'un pipeline d'apprentissage automatique ou d'ETL de données. MLflow utilise des exécutions pour suivre mlflowParam, mlflowMetric et mlflowRunTag associés à une seule exécution.

databricks experiments create-run [flags]

Arguments

None

Options

--experiment-id string

    ID de l’expérience associée.

--json JSON

    Chaîne JSON inline ou chemin @path vers le fichier JSON avec le corps de la requête

--run-name string

    Nom de l’exécution.

--start-time int

    Horodatage Unix en millisecondes du démarrage de l’exécution.

--user-id string

    ID de l’utilisateur exécutant l’exécution.

Indicateurs globaux

expériences databricks supprimer-expérience

Marquez une expérience et les métadonnées associées, les exécutions, les métriques, les paramètres et les balises à supprimer. Si l’expérience utilise FileStore, les artefacts associés à l’expérience sont également supprimés.

databricks experiments delete-experiment EXPERIMENT_ID [flags]

Arguments

EXPERIMENT_ID

    ID de l’expérience associée.

Options

--json JSON

    Chaîne JSON inline ou chemin @path vers le fichier JSON avec le corps de la requête

Indicateurs globaux

databricks expériences suppression-exécution

Marque une exécution pour suppression.

databricks experiments delete-run RUN_ID [flags]

Arguments

RUN_ID

    ID de l'exécution à supprimer.

Options

--json JSON

    Chaîne JSON inline ou chemin @path vers le fichier JSON avec le corps de la requête

Indicateurs globaux

databricks expériences delete-runs

Supprime en masse les essais d'une expérience qui ont été créés avant ou à un horodatage précis. Supprime au maximum max_runs par requête. Pour appeler cette API à partir d’un notebook Databricks en Python, vous pouvez utiliser l’extrait de code client sur

databricks experiments delete-runs EXPERIMENT_ID MAX_TIMESTAMP_MILLIS [flags]

Arguments

EXPERIMENT_ID

    ID de l’expérience contenant les exécutions à supprimer.

MAX_TIMESTAMP_MILLIS

    L'horodatage maximum de création en millisecondes depuis l'époque UNIX pour la suppression des exécutions. Seules les exécutions créées avant ou à cet horodatage seront supprimées.

Options

--json JSON

    Chaîne JSON inline ou chemin @path vers le fichier JSON avec le corps de la requête

--max-runs int

    Entier positif facultatif indiquant le nombre maximal d’exécutions à supprimer.

Indicateurs globaux

databricks expérimentations supprimer-balise

Supprimer une balise sur une exécution. Les balises sont des métadonnées d’exécution qui peuvent être mises à jour pendant une exécution et une fois l’exécution terminée.

databricks experiments delete-tag RUN_ID KEY [flags]

Arguments

RUN_ID

    ID de l'exécution à laquelle la balise a été associée Required.

KEY

    Nom de l’indicateur. La taille maximale est de 255 octets. Required.

Options

--json JSON

    Chaîne JSON inline ou chemin @path vers le fichier JSON avec le corps de la requête

Indicateurs globaux

databricks expériences get-by-name

Obtenir les métadonnées d’une expérience portant le nom spécifié.

Cette commande retourne des expériences supprimées, mais préfère l’expérience active si une expérience active et supprimée partage le même nom. Si plusieurs expériences supprimées partagent le même nom, l’API retourne l’une d’entre elles.

Lève RESOURCE_DOES_NOT_EXIST si aucune expérience portant le nom donné n'existe encore.

databricks experiments get-by-name EXPERIMENT_NAME [flags]

Arguments

EXPERIMENT_NAME

    Nom de l’expérience associée.

Options

Indicateurs globaux

expériences Databricks récupérer-expérience

Obtenir les métadonnées d’une expérience avec l’ID spécifié. Cette commande fonctionne sur les expériences supprimées.

databricks experiments get-experiment EXPERIMENT_ID [flags]

Arguments

EXPERIMENT_ID

    ID de l’expérience associée.

Options

Indicateurs globaux

databricks expérimentations obtenir-historique

Obtenez la liste de toutes les valeurs de la métrique spécifiée pour une exécution donnée.

databricks experiments get-history METRIC_KEY [flags]

Arguments

METRIC_KEY

    nom attribué à la métrique.

Options

--max-results int

    Nombre maximal d’enregistrements de métriques à retourner par requête paginée.

--page-token string

    Jeton indiquant la page d'historiques de métriques à récupérer.

--run-id string

    ID de l’exécution à partir de laquelle extraire les valeurs de métrique.

--run-uuid string

    Déconseillé, utilisez --run_id à la place. ID de l’exécution à partir de laquelle extraire les valeurs de métrique.

Indicateurs globaux

databricks expériences get-run

Obtenez les métadonnées, les métriques, les paramètres et les balises d’une exécution. Dans le cas où plusieurs métriques avec la même clé sont journalisées pour une exécution, retournez uniquement la valeur avec l’horodatage le plus récent.

S’il existe plusieurs valeurs avec le dernier horodatage, renvoyez la valeur maximale parmi celles-ci.

databricks experiments get-run RUN_ID [flags]

Arguments

RUN_ID

    ID de l'exécution à récupérer. Doit être fourni.

Options

--run-uuid string

    Déconseillé, utilisez --run_id à la place. ID de l'exécution à récupérer.

Indicateurs globaux

databricks expériences liste-artéfacts

Liste les artefacts d'une exécution. Prend un préfixe facultatif artifact_path qui, s’il est spécifié, fait en sorte que la réponse ne contienne que les artefacts ayant le préfixe spécifié. Un maximum de 1 000 artefacts seront récupérés pour les volumes catalogue Unity. Utilisez databricks fs ls pour répertorier les artefacts dans les volumes du catalogue Unity, qui prend en charge la pagination.

databricks experiments list-artifacts [flags]

Arguments

None

Options

--page-token string

    Jeton indiquant la page des résultats de l’artefact à récupérer.

--path string

    Filtrez les artefacts correspondant à ce chemin d’accès (chemin relatif à partir du répertoire d’artefacts racine).

--run-id string

    ID de l'exécution pour laquelle lister les artefacts.

--run-uuid string

    Déconseillé, utilisez --run_id à la place. ID de l'exécution pour laquelle lister les artefacts.

Indicateurs globaux

expériences databricks list-experiments

Obtenez la liste de toutes les expériences.

databricks experiments list-experiments [flags]

Arguments

None

Options

--max-results int

    Nombre maximal d’expériences souhaitées.

--page-token string

    Jeton indiquant la page des expériences à récupérer.

--view-type ViewType

    Qualificateur pour le type d’expériences à retourner. Valeurs prises en charge : ACTIVE_ONLY, ALL, DELETED_ONLY

Indicateurs globaux

databricks expériences log-batch

Consignez un lot de métriques, de paramètres et de balises pour une opération. Si des données n’ont pas pu être conservées, le serveur répond avec une erreur (code d’état autre que 200). Pour connaître le comportement de remplacement et les limites de requête, consultez Expériences.

databricks experiments log-batch [flags]

Arguments

None

Options

--json JSON

    Chaîne JSON inline ou chemin @path vers le fichier JSON avec le corps de la requête.

--run-id string

    ID de l'exécution sous laquelle enregistrer les données.

Indicateurs globaux

databricks expérimente les entrées de journal

Note

Cette commande est expérimentale.

Enregistre les entrées (telles que les jeux de données et les modèles) dans une exécution MLflow.

databricks experiments log-inputs RUN_ID [flags]

Arguments

RUN_ID

    ID de l'exécution sous laquelle enregistrer les données

Options

--json JSON

    Chaîne JSON inline ou chemin @path vers le fichier JSON avec le corps de la requête.

Indicateurs globaux

databricks expérimente log-metric

Enregistrer une métrique pour une exécution. Une métrique est une paire clé-valeur (clé de chaîne, valeur float) avec un horodatage associé. Parmi les exemples figurent les différentes métriques qui représentent la précision du modèle ML. Une métrique peut être journalisée plusieurs fois.

databricks experiments log-metric KEY VALUE TIMESTAMP [flags]

Arguments

KEY

    nom attribué à la métrique.

VALUE

    Double la valeur de la métrique en cours d'enregistrement.

TIMESTAMP

    Horodatage Unix en millisecondes au moment de l'enregistrement de la métrique.

Options

--dataset-digest string

    Synthèse du jeu de données associé à la métrique, par exemple

--dataset-name string

    Nom du jeu de données associé à la métrique.

--json JSON

    Chaîne JSON inline ou chemin @path vers le fichier JSON avec le corps de la requête.

--model-id string

    ID du modèle journalisé associé à la métrique, le cas échéant.

--run-id string

    ID de l'exécution sous laquelle enregistrer la métrique.

--run-uuid string

    Déconseillé, utilisez --run_id à la place. ID de l'exécution sous laquelle enregistrer la métrique.

--step int

    Étape à laquelle consigner la métrique.

Indicateurs globaux

expériences Databricks journalisation de modèles

Enregistrer un modèle.

Note

Cette commande est expérimentale.

databricks experiments log-model [flags]

Arguments

None

Options

--json JSON

    Chaîne JSON inline ou chemin @path vers le fichier JSON avec le corps de la requête.

--model-json string

    Fichier MLmodel au format json.

--run-id string

    ID de l'exécution sous laquelle enregistrer les données.

Indicateurs globaux

expériences databricks enregistrer-paramètre

Journaliser un paramètre utilisé pour une exécution. Un param est une paire clé-valeur (clé de chaîne, valeur de chaîne). Par exemple, les hyperparamètres utilisés pour l’entraînement du modèle ML et les dates et valeurs constantes utilisées dans un pipeline ETL. Un param ne peut être enregistré qu’une seule fois pour une exécution.

databricks experiments log-param KEY VALUE [flags]

Arguments

KEY

    Nom du paramètre. La taille maximale est de 255 octets.

VALUE

    Valeur de chaîne du paramètre en cours de journalisation. La taille maximale est de 500 octets.

Options

--json JSON

    Chaîne JSON inline ou chemin @path vers le fichier JSON avec le corps de la requête.

--run-id string

    ID de l'exécution sous laquelle enregistrer le paramètre.

--run-uuid string

    [Déconseillé, utilisez run_id à la place] ID de l'exécution sous laquelle enregistrer le paramètre.

Indicateurs globaux

expériences databricks restore-experiment

Restaure une expérience marquée comme supprimée. Cela restaure également les métadonnées associées, les exécutions, les métriques, les paramètres et les balises. Si l’expérience utilise FileStore, les artefacts sous-jacents associés à l’expérience sont également restaurés.

Lève RESOURCE_DOES_NOT_EXIST si l’expérience n’a jamais été créée ou a été définitivement supprimée.

databricks experiments restore-experiment EXPERIMENT_ID [flags]

Arguments

EXPERIMENT_ID

    ID de l’expérience associée.

Options

--json JSON

    Chaîne JSON inline ou chemin @path vers le fichier JSON avec le corps de la requête.

Indicateurs globaux

databricks Expériences restaurer-la-exécution

Restaurez une exécution supprimée. Cela restaure également les métadonnées associées, les exécutions, les métriques, les paramètres et les balises.

Lève RESOURCE_DOES_NOT_EXIST si l’exécution n’a jamais été créée ou a été définitivement supprimée.

databricks experiments restore-run RUN_ID [flags]

Arguments

RUN_ID

    ID de l'exécution à restaurer.

Options

--json JSON

    Chaîne JSON inline ou chemin @path vers le fichier JSON avec le corps de la requête.

Indicateurs globaux

databricks expérimente des exécutions de restauration

Restaure en masse les exécutions d'une expérience supprimées depuis l'horodatage spécifié. Restaure au maximum max_runs par requête.

databricks experiments restore-runs EXPERIMENT_ID MIN_TIMESTAMP_MILLIS [flags]

Arguments

EXPERIMENT_ID

    L'ID de l'expérience contenant les exécutions à restaurer.

MIN_TIMESTAMP_MILLIS

    L'horodatage minimum de suppression (en millisecondes depuis l'époque UNIX) pour la restauration des exécutions. Seules les exécutions supprimées à partir de cet horodatage seront restaurées.

Options

--json JSON

    Chaîne JSON inline ou chemin @path vers le fichier JSON avec le corps de la requête.

--max-runs int

    Un entier positif facultatif indiquant le nombre maximal d'exécutions à restaurer.

Indicateurs globaux

expériences databricks search-experiments

Recherche des expériences qui répondent aux critères de recherche spécifiés.

databricks experiments search-experiments [flags]

Arguments

None

Options

--filter string

    Chaîne représentant une condition de filtre SQL

--json JSON

    Chaîne JSON inline ou chemin @path vers le fichier JSON avec le corps de la requête.

--max-results int

    Nombre maximal d’expériences souhaitées.

--page-token string

    Jeton indiquant la page des expériences à récupérer.

--view-type ViewType

    Qualificateur pour le type d’expériences à retourner. Valeurs prises en charge : ACTIVE_ONLY, ALL, DELETED_ONLY

Indicateurs globaux

databricks expérimente les exécutions de recherche

Recherche les exécutions correspondant aux critères spécifiés. Les expressions de recherche peuvent utiliser des clés mlflowMetric et mlflowParam.

databricks experiments search-runs [flags]

Arguments

None

Options

--filter string

    Expression de filtre sur les paramètres, les métriques et les balises, qui permet de retourner un sous-ensemble d’exécutions.

--json JSON

    Chaîne JSON inline ou chemin @path vers le fichier JSON avec le corps de la requête.

--max-results int

    Nombre maximal d’exécutions souhaitées.

--page-token string

    Jeton pour la page actuelle d'exécutions.

--run-view-type ViewType

    Indique s’il faut afficher uniquement les exécutions actives, supprimées uniquement ou toutes les exécutions. Valeurs prises en charge : ACTIVE_ONLY, ALL, DELETED_ONLY

Indicateurs globaux

databricks experiments set-experiment-tag

Définit une balise sur une expérience. Les balises d’expérience sont des métadonnées qui peuvent être mises à jour.

databricks experiments set-experiment-tag EXPERIMENT_ID KEY VALUE [flags]

Arguments

EXPERIMENT_ID

    ID de l'expérience sous laquelle enregistrer la balise. Doit être fourni.

KEY

    Nom de l’indicateur. Les clés jusqu’à 250 octets de taille sont prises en charge.

VALUE

    Valeur de chaîne de la balise enregistrée. Les valeurs jusqu’à 64 Ko de taille sont prises en charge.

Options

--json JSON

    Chaîne JSON inline ou chemin @path vers le fichier JSON avec le corps de la requête.

Indicateurs globaux

databricks expériences définir-tag

Attribue une balise à une exécution. Les balises sont des métadonnées d’exécution qui peuvent être mises à jour pendant une exécution et une fois l’exécution terminée.

databricks experiments set-tag KEY VALUE [flags]

Arguments

KEY

    Nom de l’indicateur. Les clés jusqu’à 250 octets de taille sont prises en charge.

VALUE

    Valeur de chaîne de la balise enregistrée. Les valeurs jusqu’à 64 Ko de taille sont prises en charge.

Options

--json JSON

    Chaîne JSON inline ou chemin @path vers le fichier JSON avec le corps de la requête.

--run-id string

    ID du processus dans lequel enregistrer la balise.

--run-uuid string

    Déconseillé, utilisez --run_id à la place. ID du processus dans lequel enregistrer la balise.

Indicateurs globaux

expériences Databricks mise à jour-experience

Mettez à jour une expérience.

databricks experiments update-experiment EXPERIMENT_ID [flags]

Arguments

EXPERIMENT_ID

    ID de l’expérience associée.

Options

--json JSON

    Chaîne JSON inline ou chemin @path vers le fichier JSON avec le corps de la requête.

--new-name string

    Si le nom de l'expérience est fourni, il est remplacé par le nouveau nom.

Indicateurs globaux

Mise à jour de l'exécution des expériences Databricks

Modifie une exécution.

databricks experiments update-run [flags]

Arguments

None

Options

--end-time int

    Horodatage Unix en millisecondes de la fin de l'exécution.

--json JSON

    Chaîne JSON inline ou chemin @path vers le fichier JSON avec le corps de la requête.

--run-id string

    ID de l'exécution à modifier.

--run-name string

    Nom modifié de l'exécution.

--run-uuid string

    Déconseillé, utilisez --run_id à la place. ID de l'exécution à modifier.

--status UpdateRunStatus

    Statut modifié de l'exécution. Valeurs prises en charge : FAILED, , FINISHEDKILLED, RUNNINGSCHEDULED

Indicateurs globaux

databricks expériences get-permission-levels

Obtenir les niveaux d'autorisation d'une expérience.

databricks experiments get-permission-levels EXPERIMENT_ID [flags]

Arguments

EXPERIMENT_ID

    L'expérience pour laquelle obtenir ou gérer les autorisations.

Options

Indicateurs globaux

databricks expérimentations récupérer-les-autorisations

Obtenez les autorisations d’une expérience. Les expériences peuvent hériter des autorisations de leur objet racine.

databricks experiments get-permissions EXPERIMENT_ID [flags]

Arguments

EXPERIMENT_ID

    L'expérience pour laquelle obtenir ou gérer les autorisations.

Options

Indicateurs globaux

Databricks expérience définir-les-autorisations

Définissez les autorisations d’expérience.

Définit des autorisations sur un objet, en remplaçant les autorisations existantes s’ils 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 experiments set-permissions EXPERIMENT_ID [flags]

Arguments

EXPERIMENT_ID

    L'expérience pour laquelle obtenir ou gérer les autorisations.

Options

--json JSON

    Chaîne JSON inline ou chemin @path vers le fichier JSON avec le corps de la requête.

Indicateurs globaux

databricks expérimente les autorisations de mise à jour

Mettez à jour les autorisations d’expérience. Les expériences peuvent hériter des autorisations de leur objet racine.

databricks experiments update-permissions EXPERIMENT_ID [flags]

Arguments

EXPERIMENT_ID

    L'expérience pour laquelle obtenir ou gérer les autorisations.

Options

--json JSON

    Chaîne JSON inline ou chemin @path vers le fichier JSON avec le corps de la requête.

Indicateurs globaux

Indicateurs globaux

--debug

  Active la journalisation du débogage.

-h ou --help

    Affiche l’aide pour l’interface CLI de Databricks, le groupe de commandes associé ou la commande concernée.

--log-file chaîne

    Chaîne représentant le fichier dans lequel écrire les journaux de sortie. Si cet indicateur n’est pas défini, les journaux de sortie sont écrits par défaut dans stderr.

--log-format format

    Format des journaux : text ou json. La valeur par défaut est text.

--log-level chaîne

    Chaîne représentant le niveau de journalisation. Si cet indicateur n’est pas défini, le niveau de format de journal est désactivé.

Type -o, --output

    Type de sortie de commande, text ou json. La valeur par défaut est text.

-p, --profile chaîne

    Nom du profil dans le ~/.databrickscfg fichier à utiliser pour exécuter la commande. Si cet indicateur n’est pas spécifié, s’il existe, le profil nommé DEFAULT est utilisé.

--progress-format format

    Format d’affichage des journaux d’activité de progression : default, append, inplace ou json

-t, --target chaîne

    Le cas échéant, la cible d’offre groupée à utiliser