Teilen über


experiments 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.

Mit experiments der Befehlsgruppe in der Databricks CLI können Sie Experimente in MLflow erstellen, bearbeiten, löschen und verwalten. Weitere Informationen finden Sie unter Organisieren von Trainingsausführungen mit MLflow-Experimenten.

Databricks Experimente erstellen: create-experiment

Erstellen Sie ein Experiment mit einem Namen. Gibt die ID des neu erstellten Experiments zurück. Überprüft, ob ein weiteres Experiment mit demselben Namen noch nicht vorhanden ist und fehlschlägt, wenn bereits ein anderes Experiment mit demselben Namen vorhanden ist.

Löst RESOURCE_ALREADY_EXISTS aus, wenn ein Experiment mit dem angegebenen Namen existiert.

databricks experiments create-experiment NAME [flags]

Arguments

NAME

    Experimentname.

Options

--artifact-location string

    Speicherort, an dem alle Artefakte für das Experiment gespeichert werden.

--json JSON

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

Globale Kennzeichnungen

Databricks-Experimente erstellen-ausführen

Erstellen einer neuen Ausführung innerhalb eines Experiments. Ein Lauf ist in der Regel eine einzelne Ausführung einer Machine Learning- oder Daten-ETL-Pipeline. MLflow verwendet Läufe, um die mit einer einzelnen Ausführung verbundenen mlflowParam-, mlflowMetric- und mlflowRunTag-Attribute nachzuverfolgen.

databricks experiments create-run [flags]

Arguments

None

Options

--experiment-id string

    ID des zugeordneten Experiments.

--json JSON

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

--run-name string

    Name der Ausführung

--start-time int

    Unix-Zeitstempel in Millisekunden des Zeitpunkts, an dem die Ausführung gestartet wurde.

--user-id string

    DIE ID des Benutzers, der die Ausführung ausführt.

Globale Kennzeichnungen

Databricks-Experimente löschen-experiment

Markieren Sie ein Experiment und die zugehörigen Metadaten, Läufe, Metriken, Parameter und Tags zur Löschung. Wenn das Experiment FileStore verwendet, werden auch Artefakte gelöscht, die dem Experiment zugeordnet sind.

databricks experiments delete-experiment EXPERIMENT_ID [flags]

Arguments

EXPERIMENT_ID

    ID des zugeordneten Experiments.

Options

--json JSON

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

Globale Kennzeichnungen

Databricks-Experimente Lauf löschen

Markieren einer Ausführung zur Löschung.

databricks experiments delete-run RUN_ID [flags]

Arguments

RUN_ID

    ID der zu löschenden Ausführung.

Options

--json JSON

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

Globale Kennzeichnungen

databricks Experimente Läufe löschen

Löschen von Bulk-Ausführungen in einem Experiment, die vor oder zum angegebenen Zeitstempel erstellt wurden. Löscht maximal max_runs pro Anfrage. Um diese API aus einem Databricks-Notizbuch in Python aufzurufen, können Sie das Client-Code-Snippet verwenden.

databricks experiments delete-runs EXPERIMENT_ID MAX_TIMESTAMP_MILLIS [flags]

Arguments

EXPERIMENT_ID

    Die ID des Experiments, das die zu löschenden Läufe enthält.

MAX_TIMESTAMP_MILLIS

    Der maximale Erstellungszeitstempel in Millisekunden seit der UNIX-Epoche zum Löschen von Ausführungen. Es werden nur Ausführungen gelöscht, die vor oder zu diesem Zeitstempel erstellt wurden.

Options

--json JSON

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

--max-runs int

    Eine optionale positive ganze Zahl, die die maximale Anzahl der zu löschenden Läufe angibt.

Globale Kennzeichnungen

databricks-Experimente Tag löschen

Löscht ein Tag in einer Ausführung. Tags sind Ausführungsmetadaten, die während einer Ausführung und nach Abschluss einer Ausführung aktualisiert werden können.

databricks experiments delete-tag RUN_ID KEY [flags]

Arguments

RUN_ID

    ID der Ausführung, unter der der Tag protokolliert wurde. Required.

KEY

    Name des Tags. Die maximale Größe beträgt 255 Byte. Required.

Options

--json JSON

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

Globale Kennzeichnungen

Databricks-Experimente abrufen-nach-Name

Abrufen von Metadaten für ein Experiment mit dem angegebenen Namen.

Dieser Befehl gibt gelöschte Experimente zurück, bevorzugt jedoch das aktive Experiment, wenn ein aktives und gelöschtes Experiment denselben Namen aufweist. Wenn mehrere gelöschte Experimente denselben Namen aufweisen, gibt die API eine davon zurück.

Wirft RESOURCE_DOES_NOT_EXIST, wenn kein Experiment mit dem angegebenen Namen existiert.

databricks experiments get-by-name EXPERIMENT_NAME [flags]

Arguments

EXPERIMENT_NAME

    Name des zugeordneten Experiments.

Options

Globale Kennzeichnungen

databricks Experimente get-experiment

Abrufen von Metadaten für ein Experiment mit der angegebenen ID. Dieser Befehl funktioniert bei gelöschten Experimenten.

databricks experiments get-experiment EXPERIMENT_ID [flags]

Arguments

EXPERIMENT_ID

    ID des zugeordneten Experiments.

Options

Globale Kennzeichnungen

Databricks-Experimente – Get-History

Dient zum Abrufen einer Liste aller Werte für die angegebene Metrik für eine bestimmte Ausführung.

databricks experiments get-history METRIC_KEY [flags]

Arguments

METRIC_KEY

    Der Name der Metrik.

Options

--max-results int

    Maximale Anzahl von Metrikdatensätzen, die pro paginierte Anforderung zurückgegeben werden sollen.

--page-token string

    Token, das die Seite der abzurufenden Metrikhistorien angibt.

--run-id string

    ID der Ausführung, aus der Metrikwerte abgerufen werden sollen.

--run-uuid string

    Veraltet, verwenden Sie --run_id stattdessen. ID der Ausführung, aus der Metrikwerte abgerufen werden sollen.

Globale Kennzeichnungen

databricks experiments get-run

Rufen Sie die Metadaten, Metriken, Parameter und Tags für einen Lauf ab. Wenn für eine Ausführung mehrere Metriken mit demselben Schlüssel protokolliert werden, geben Sie nur den Wert mit dem neuesten Zeitstempel zurück.

Wenn mehrere Werte mit dem neuesten Zeitstempel vorhanden sind, geben Sie das Maximum dieser Werte zurück.

databricks experiments get-run RUN_ID [flags]

Arguments

RUN_ID

    ID der Ausführung, die abgefragt werden soll. Muss bereitgestellt werden.

Options

--run-uuid string

    Veraltet, verwenden Sie --run_id stattdessen. ID der Ausführung, die abgefragt werden soll.

Globale Kennzeichnungen

databricks experiments list-artifacts

Auflisten von Artefakten für einen Lauf. Verwendet ein optionales "artifact_path"-Präfix, das dazu führt, dass die Antwort nur Artefakte mit dem angegebenen Präfix enthält, wenn es angegeben ist. Für Unity-Katalogvolumes werden maximal 1000 Artefakte abgerufen. Verwenden Sie databricks fs ls zum Auflisten von Artefakten in Unity-Katalogvolumes, die die Paginierung unterstützen.

databricks experiments list-artifacts [flags]

Arguments

None

Options

--page-token string

    Das Token, das die Seite der artefaktergebnisse angibt, die abgerufen werden sollen.

--path string

    Filterartefakte, die diesem Pfad entsprechen (ein relativer Pfad aus dem Stammartefaktverzeichnis).

--run-id string

    ID der Ausführung, deren Artefakte aufgelistet werden sollen.

--run-uuid string

    Veraltet, verwenden Sie --run_id stattdessen. ID der Ausführung, deren Artefakte aufgelistet werden sollen.

Globale Kennzeichnungen

databricks experiments list-experiments

Dient zum Abrufen einer Liste aller Experimente.

databricks experiments list-experiments [flags]

Arguments

None

Options

--max-results int

    Maximale Anzahl der gewünschten Experimente.

--page-token string

    Token, das die Seite von Experimenten angibt, die abgerufen werden sollen.

--view-type ViewType

    Kriterium für die Art der Experimente, die zurückgegeben werden sollen. Unterstützte Werte: ACTIVE_ONLY, ALL, DELETED_ONLY

Globale Kennzeichnungen

Databricks Experimente Log-Batch

Protokollieren Sie einen Batch von Metriken, Params und Tags für eine Ausführung. Wenn Daten nicht gespeichert werden konnten, antwortet der Server mit einem Fehler (einem nicht-200-Statuscode). Informationen zum Überschreiben von Verhalten und Anforderungsbeschränkungen finden Sie unter "Experimente".

databricks experiments log-batch [flags]

Arguments

None

Options

--json JSON

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

--run-id string

    ID der Ausführung, unter der protokolliert werden soll.

Globale Kennzeichnungen

databricks Experimente Log-Eingaben

Note

Dieser Befehl ist experimentell.

Protokolliert Daten, wie Datensätze und Modelle, während eines MLflow-Durchlaufs.

databricks experiments log-inputs RUN_ID [flags]

Arguments

RUN_ID

    ID der Ausführung, unter der protokolliert werden soll.

Options

--json JSON

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

Globale Kennzeichnungen

Databricks-Experimente Metrikprotokollierung

Protokolliert eine Metrik für eine Ausführung. Eine Metrik ist ein Schlüssel-Wert-Paar (Zeichenfolgenschlüssel, Float-Wert) mit einem zugeordneten Zeitstempel. Beispiele sind die verschiedenen Metriken, die die ML-Modellgenauigkeit darstellen. Eine Metrik kann mehrmals protokolliert werden.

databricks experiments log-metric KEY VALUE TIMESTAMP [flags]

Arguments

KEY

    Der Name der Metrik.

VALUE

    Doppelter Wert der Metrik, die protokolliert wird.

TIMESTAMP

    Unix-Zeitstempel in Millisekunden zum Zeitpunkt, zu dem die Metrik protokolliert wurde.

Options

--dataset-digest string

    Übersicht des Datensatzes, der der Metrik zugeordnet ist, z. B.

--dataset-name string

    Der Name des Datasets, das der Metrik zugeordnet ist.

--json JSON

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

--model-id string

    ID des protokollierten Modells, das der Metrik zugeordnet ist, falls zutreffend.

--run-id string

    ID der Ausführung, unter der die Metrik protokolliert werden soll.

--run-uuid string

    Veraltet, verwenden Sie --run_id stattdessen. ID der Ausführung, unter der die Metrik protokolliert werden soll.

--step int

    Schritt, an dem die Metrik protokolliert werden soll.

Globale Kennzeichnungen

Databricks-Experimente Log-Modell

Loggen Sie ein Modell.

Note

Dieser Befehl ist experimentell.

databricks experiments log-model [flags]

Arguments

None

Options

--json JSON

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

--model-json string

    MLmodel-Datei im JSON-Format.

--run-id string

    ID der Ausführung, unter der protokolliert werden soll.

Globale Kennzeichnungen

databricks experiments log-param

Protokollieren Sie einen Param, der für eine Ausführung verwendet wird. Ein Param ist ein Schlüssel-Wert-Paar (Zeichenfolgenschlüssel, Zeichenfolgenwert). Beispiele sind Hyperparameter, die für ML-Modellschulungen und konstante Datumsangaben und Werte verwendet werden, die in einer ETL-Pipeline verwendet werden. Ein Param kann nur einmal für eine Ausführung protokolliert werden.

databricks experiments log-param KEY VALUE [flags]

Arguments

KEY

    Der Name des Parameters. Die maximale Größe beträgt 255 Byte.

VALUE

    Zeichenfolgenwert des protokollierten Parameters. Die maximale Größe beträgt 500 Bytes.

Options

--json JSON

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

--run-id string

    ID der Ausführung, unter der der Param protokolliert werden soll.

--run-uuid string

    [Veraltet; verwenden Sie stattdessen run_id] ID der Ausführung, unter der der Param protokolliert werden soll.

Globale Kennzeichnungen

Databricks-Experiment wiederherstellen

Stellen Sie ein experiment wieder her, das zum Löschen markiert ist. Dadurch werden auch zugeordnete Metadaten, Ausführungen, Metriken, Params und Tags wiederhergestellt. Wenn das Experiment FileStore verwendet, werden auch zugrunde liegende Artefakte wiederhergestellt, die dem Experiment zugeordnet sind.

Wirft RESOURCE_DOES_NOT_EXIST, wenn das Experiment nie erstellt oder dauerhaft gelöscht wurde.

databricks experiments restore-experiment EXPERIMENT_ID [flags]

Arguments

EXPERIMENT_ID

    ID des zugeordneten Experiments.

Options

--json JSON

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

Globale Kennzeichnungen

databricks Experimente Wiederherstellungs-Vorgang

Wiederherstellen einer gelöschten Ausführung. Dadurch werden auch zugeordnete Metadaten, Ausführungen, Metriken, Params und Tags wiederhergestellt.

Löst RESOURCE_DOES_NOT_EXIST aus, wenn die Ausführung nie erstellt wurde oder dauerhaft gelöscht wurde.

databricks experiments restore-run RUN_ID [flags]

Arguments

RUN_ID

    ID der Ausführung, die wiederhergestellt werden soll.

Options

--json JSON

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

Globale Kennzeichnungen

Databricks-Experimente Wiederherstellen von Läufen

Bulk-Wiederherstellung von Ausführungen in einem Experiment, die nicht vor dem angegebenen Zeitstempel gelöscht wurden. Stellt höchstens max_runs pro Anfrage wieder her.

databricks experiments restore-runs EXPERIMENT_ID MIN_TIMESTAMP_MILLIS [flags]

Arguments

EXPERIMENT_ID

    Die ID des Experiments, das die wiederherzustellenden Ausführungen enthält.

MIN_TIMESTAMP_MILLIS

    Der Mindestzeitstempel der Löschung in Millisekunden seit der UNIX-Epoche für die Wiederherstellung von Ausführungen. Nur Läufe, die nicht früher als zu diesem Zeitstempel gelöscht wurden, werden wiederhergestellt.

Options

--json JSON

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

--max-runs int

    Eine optionale positive ganze Zahl, die die höchste Anzahl von Wiedergabeabläufen angibt, die wiederhergestellt werden sollen.

Globale Kennzeichnungen

Databricks experimentiert Suchexperimente

Sucht nach Experimenten, die bestimmte Suchkriterien erfüllen.

databricks experiments search-experiments [flags]

Arguments

None

Options

--filter string

    Zeichenfolge, die eine SQL-Filterbedingung darstellt

--json JSON

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

--max-results int

    Maximale Anzahl der gewünschten Experimente.

--page-token string

    Token, das die Seite von Experimenten angibt, die abgerufen werden sollen.

--view-type ViewType

    Kriterium für die Art der Experimente, die zurückgegeben werden sollen. Unterstützte Werte: ACTIVE_ONLY, ALL, DELETED_ONLY

Globale Kennzeichnungen

databricks Experimente Suchläufe

Sucht nach Ausführungen, die Ausdrücke erfüllen. Suchausdrücke können mlflowMetric- und mlflowParam-Tasten verwenden.

databricks experiments search-runs [flags]

Arguments

None

Options

--filter string

    Ein Filterausdruck über Parameter, Metriken und Tags, mit dem eine Teilmenge der Ausführungen zurückgegeben werden kann.

--json JSON

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

--max-results int

    Maximale Anzahl der gewünschten Ausführungsläufe.

--page-token string

    Token für die aktuelle Seite der Ausführungen.

--run-view-type ViewType

    Gibt an, ob nur aktive, nur gelöschte oder alle Durchläufe angezeigt werden sollen. Unterstützte Werte: ACTIVE_ONLY, ALL, DELETED_ONLY

Globale Kennzeichnungen

databricks experiments Experiment-Tag festlegen

Legt ein Etikett an einem Experiment fest. Experimenttags sind Metadaten, die aktualisiert werden können.

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

Arguments

EXPERIMENT_ID

    ID des Experiments, unter dem das Tag protokolliert werden soll. Muss bereitgestellt werden.

KEY

    Name des Tags. Schlüssel mit einer Größe von bis zu 250 Bytes werden unterstützt.

VALUE

    Zeichenfolgenwert des Tags, das protokolliert wird. Werte mit einer Größe von bis zu 64 KB werden unterstützt.

Options

--json JSON

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

Globale Kennzeichnungen

databricks Experimente Tag setzen

Legt ein Tag für eine Ausführung fest. Tags sind Ausführungsmetadaten, die während einer Ausführung und nach Abschluss einer Ausführung aktualisiert werden können.

databricks experiments set-tag KEY VALUE [flags]

Arguments

KEY

    Name des Tags. Schlüssel mit einer Größe von bis zu 250 Bytes werden unterstützt.

VALUE

    Zeichenfolgenwert des Tags, das protokolliert wird. Werte mit einer Größe von bis zu 64 KB werden unterstützt.

Options

--json JSON

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

--run-id string

    ID der Ausführung, unter der der Tag protokolliert werden soll.

--run-uuid string

    Veraltet, verwenden Sie --run_id stattdessen. ID der Ausführung, unter der der Tag protokolliert werden soll.

Globale Kennzeichnungen

databricks-Experimente Update-Experiment

Aktualisieren eines Experiments.

databricks experiments update-experiment EXPERIMENT_ID [flags]

Arguments

EXPERIMENT_ID

    ID des zugeordneten Experiments.

Options

--json JSON

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

--new-name string

    Wenn angegeben, wird der Name des Experiments in den neuen Namen geändert.

Globale Kennzeichnungen

databricks Experimente Aktualisieren-Lauf

Aktualisieren eines Laufs.

databricks experiments update-run [flags]

Arguments

None

Options

--end-time int

    Unix-Zeitstempel in Millisekunden zum Zeitpunkt des Abschlusses der Ausführung.

--json JSON

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

--run-id string

    ID der zu aktualisierenden Ausführung.

--run-name string

    Aktualisierter Name der Ausführung.

--run-uuid string

    Veraltet, verwenden Sie --run_id stattdessen. ID der zu aktualisierenden Ausführung.

--status UpdateRunStatus

    Der Ausführungsstatus wurde aktualisiert. Unterstützte Werte: FAILED, FINISHED, KILLED, , RUNNINGSCHEDULED

Globale Kennzeichnungen

Databricks-Experimente: Berechtigungsstufen abrufen

Abrufen von Experimentberechtigungsstufen

databricks experiments get-permission-levels EXPERIMENT_ID [flags]

Arguments

EXPERIMENT_ID

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

Options

Globale Kennzeichnungen

databricks Experimente Berechtigungen abrufen

Lesen Sie die Berechtigungen eines Experiments aus. Experimente können Berechtigungen von ihrem Stammobjekt erben.

databricks experiments get-permissions EXPERIMENT_ID [flags]

Arguments

EXPERIMENT_ID

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

Options

Globale Kennzeichnungen

databricks Experimente set-permissions

Legen Sie Experimentberechtigungen fest.

Legt Berechtigungen für ein Objekt fest, wobei vorhandene Berechtigungen ersetzt werden, sofern vorhanden. Löscht alle direkten Berechtigungen, wenn keine angegeben sind. Objekte können Berechtigungen vom Stammobjekt erben.

databricks experiments set-permissions EXPERIMENT_ID [flags]

Arguments

EXPERIMENT_ID

    Das Experiment, 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-Experimente Berechtigungen-aktualisieren

Aktualisieren von Experimentberechtigungen. Experimente können Berechtigungen von ihrem Stammobjekt erben.

databricks experiments update-permissions EXPERIMENT_ID [flags]

Arguments

EXPERIMENT_ID

    Das Experiment, 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