-
Notifications
You must be signed in to change notification settings - Fork 7
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.
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
update repr_llm
and add DataFrameSummarizer
with customizable summarizing function
#323
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
from typing import Callable, Optional | ||
|
||
import pandas as pd | ||
|
||
|
||
class DataFrameSummarizer: | ||
_instance: "DataFrameSummarizer" = None | ||
summarizing_func: Optional[Callable] = None | ||
|
||
def __init__(self, summarizing_func: Optional[Callable] = None): | ||
if summarizing_func is None: | ||
self._try_to_load_repr_llm() | ||
else: | ||
self.summarizing_func = summarizing_func | ||
|
||
def _try_to_load_repr_llm(self) -> None: | ||
"""Load repr_llm's summarize_dataframe into the summarizing_func if it's available.""" | ||
try: | ||
from repr_llm.pandas import summarize_dataframe | ||
|
||
self.summarizing_func = summarize_dataframe | ||
except ImportError: | ||
return | ||
|
||
@classmethod | ||
def instance(cls) -> "DataFrameSummarizer": | ||
if cls._instance is None: | ||
cls._instance = cls() | ||
return cls._instance | ||
|
||
def summarize(self, df: pd.DataFrame) -> str: | ||
"""Generate a summary of a dataframe using the configured summarizing_func.""" | ||
if not isinstance(df, pd.DataFrame): | ||
raise ValueError("`df` must be a pandas DataFrame") | ||
|
||
if self.summarizing_func is None: | ||
return df.describe().to_string() | ||
|
||
return self.summarizing_func(df) | ||
|
||
|
||
def get_summarizing_function() -> Optional[Callable]: | ||
"""Get the function to use for summarizing dataframes.""" | ||
return DataFrameSummarizer.instance().summarizing_func | ||
|
||
|
||
def set_summarizing_function(func: Callable) -> None: | ||
"""Set the function to use for summarizing dataframes.""" | ||
DataFrameSummarizer.instance().summarizing_func = func | ||
|
||
|
||
def make_df_summary(df: pd.DataFrame) -> str: | ||
"""Generate a summary of a dataframe using the configured summarizing_func.""" | ||
return DataFrameSummarizer.instance().summarize(df) |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If they set it here, shouldn't we not load repr llm's version?
The
summarizing_func
passed in is likely overridden by the call within_load_repr_llm
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good point - updating