-
-
Notifications
You must be signed in to change notification settings - Fork 19.6k
DOC : document pyarrow vs python string trade-offs #63505
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
Open
joddeepesh-cloud
wants to merge
2
commits into
pandas-dev:main
Choose a base branch
from
joddeepesh-cloud:docs-string-pyarrow
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -91,6 +91,41 @@ See :ref:`text.four_string_variants` section below for details. | |
|
|
||
| .. _text.string_methods: | ||
|
|
||
| String storage: pyarrow vs python | ||
| --------------------------------- | ||
|
|
||
| Pandas supports different storage backends for string data. | ||
| Depending on the configuration and installed dependencies, | ||
| string data may be stored using either a Python object-based | ||
| implementation or a pyarrow-backed implementation. | ||
|
|
||
| In general, the pyarrow-backed string storage is recommended | ||
| for most users, as it provides better performance and a more | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. PyArrow is not more performant across the board, nor is it a more compact memory representation in all cases. Python will cache certain strings, leading to much less memory usage with Python storage. PyArrow does not do this. size = 10
df = pd.DataFrame(
{
"a": [f"{e}" for e in range(100)] * size,
"b": np.random.randint(0, 100_000, size * 100)
}
)
df["b"] = df["b"].map(str).astype("object")
gb = df.groupby("a")
gb.sum() # Populate caches
%timeit gb.sum()
# 83.4 μs ± 435 ns per loop (mean ± std. dev. of 7 runs, 10,000 loops each)
df_arrow = df.convert_dtypes(dtype_backend="pyarrow")
gb = df_arrow.groupby("a")
gb.sum() # Populate caches
%timeit gb.sum()
# 6.75 ms ± 30.3 μs per loop (mean ± std. dev. of 7 runs, 100 loops each) |
||
| compact memory representation. | ||
|
|
||
| **pyarrow-backed string storage** | ||
|
|
||
| - Pros: | ||
| - More compact memory footprint | ||
| - Faster vectorized string operations | ||
| - Cons: | ||
| - Strings are immutable; modifying values results in new arrays | ||
| - Some edge-case behavior differences compared to Python strings | ||
|
|
||
| **Python object string storage** | ||
|
|
||
| - Pros: | ||
| - Uses Python string objects (mutable at the array level) | ||
| - Behavior consistent with standard Python string semantics | ||
| - Cons: | ||
| - Higher memory usage | ||
| - Slower performance due to lack of vectorization | ||
|
|
||
| While pandas aims to provide identical results regardless of | ||
| the underlying string storage, some behavior differences may | ||
| exist in edge cases (for example, certain Unicode operations). | ||
| These differences are documented where relevant. | ||
|
|
||
| String methods | ||
| ============== | ||
|
|
||
|
|
||
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.
Uh oh!
There was an error while loading. Please reload this page.