[ENH] Add support to convert Get/QueryResult to pandas dataframe #4304
Conversation
This file contains hidden or 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
Reviewer ChecklistPlease leverage this checklist to ensure your code review is thorough before approving Testing, Bugs, Errors, Logs, Documentation
System Compatibility
Quality
|
This stack of pull requests is managed by Graphite. Learn more about stacking. |
jairad26
force-pushed
the
jai/df-query-res
branch
from
003dfae to
ba51cf1
Compare
jairad26
force-pushed
the
jai/df-query-res
branch
from
ba51cf1 to
b486c1b
Compare
jairad26
force-pushed
the
jai/df-query-res
branch
from
b486c1b to
5b56585
Compare
HammadB
reviewed
Apr 26, 2025
chromadb/api/types.py
Outdated
| @@ -419,6 +419,10 @@ class QueryResult(TypedDict): | |||
| included: Include | |||
|
|
|||
|
|
|||
| # Type alias for union of result types | |||
| GetOrQueryResult = Union["QueryResult", "GetResult"] | |||
There was a problem hiding this comment.
I think we should do two different types here. Commingling them makes it more complicated than necessary.
There was a problem hiding this comment.
separated, now theres 2 functions: query_result_to_df and get_result_to_df
jairad26
force-pushed
the
jai/df-query-res
branch
from
5b56585 to
a42164b
Compare
HammadB
reviewed
Apr 29, 2025
chromadb/utils/results.py
Outdated
|
|
||
| data_for_df["id"] = query_result["ids"][i] | ||
|
|
||
| if "documents" in included_fields and query_result["documents"] is not None: |
There was a problem hiding this comment.
Can we generalize this behavior into a helper? Its all the same
jairad26
force-pushed
the
jai/df-query-res
branch
2 times, most recently
from
4647db9 to
3b3363d
Compare
HammadB
requested changes
Apr 29, 2025
jairad26
force-pushed
the
jai/df-query-res
branch
6 times, most recently
from
97ed1a2 to
b705d6d
Compare
jairad26
force-pushed
the
jai/df-query-res
branch
from
b705d6d to
a5eb712
Compare
1 task
HammadB
approved these changes
May 5, 2025
warpbuild-benchmark-bot bot
added a commit
to WarpBuilds/chroma
that referenced
this pull request
May 5, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description of changes
This PR adds support to convert both get and query results to pandas dataframes. As a byproduct, users can now get results in row format.
Test plan
How are these changes tested?
pytestfor python,yarn testfor js,cargo testfor rustDocumentation Changes
Are all docstrings for user-facing APIs updated if required? Do we need to make documentation changes in the docs repository?