Skip to content

[DOC] complete docstring for Hyperactive.search_data #118

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
SimonBlanke merged 1 commit into from
May 17, 2025
Merged

[DOC] complete docstring for Hyperactive.search_data #118

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions src/hyperactive/hyperactive.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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_)
Expand Down
Loading