From 50914e2ca99f624e12361cad51838c91b8fd5f45 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Franz=20Kir=C3=A1ly?= <fkiraly@gcos.ai>
Date: Sat, 17 May 2025 09:59:54 +0200
Subject: [PATCH] Update hyperactive.py

---
 src/hyperactive/hyperactive.py | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/src/hyperactive/hyperactive.py b/src/hyperactive/hyperactive.py
index 18face95..860a65f1 100644
--- a/src/hyperactive/hyperactive.py
+++ b/src/hyperactive/hyperactive.py
@@ -245,6 +245,16 @@ def search_data(self, id_, times=False):
 
         Returns:
         - pd.DataFrame: The search data for the specified ID.
+
+        columns are
+
+            * "score" : float - The score of the search
+            * "n_columns" : int - The number of columns in the search space
+            * "metadata" : dict - The metadata returned by the search
+
+        each row is a search iteration
+
+        index is RangeIndex
         """
 
         search_data_ = self.results_.search_data(id_)