API: Add sparse Acessor #23183
API: Add sparse Acessor #23183
Conversation
* Adds a Series.sparse accessor * Adds several methods to SparseArray to for use via the accessor
|
Hello @TomAugspurger! Thanks for submitting the PR.
|
Codecov Report
@@ Coverage Diff @@
## master #23183 +/- ##
==========================================
- Coverage 92.23% 92.22% -0.01%
==========================================
Files 169 169
Lines 50924 50962 +38
==========================================
+ Hits 46968 47001 +33
- Misses 3956 3961 +5
Continue to review full report at Codecov.
|
|
Latest commit should fix the doc rendering for Series.sparse.to_coo and Series.sparse.from_coo (we just need to use the regular |
doc/source/whatsnew/v0.24.0.txt
Outdated
| Some new warnings are issued for operations that require or are likely to materialize a large dense array: | ||
|
|
||
| - A :class:`errors.PerformanceWarning` is issued when using fillna with a ``method``, as a dense array is constructed to create the filled array. Filling with a ``value`` is the efficient way to fill a sparse array. | ||
| - A :class:`errors.PerformanceWarning` is now issued when concatenating sparse Series with differing fill values. The fill value from the first sparse array continues to be used. | ||
|
|
||
| In addition to these API breaking changes, many :ref:`performance improvements and bug fixes have been made <whatsnew_0240.bug_fixes.sparse>`. | ||
|
|
||
| Finally, a ``Series.sparse`` accessor has added to provide sparse-specific methods and attributes. |
There was a problem hiding this comment.
Can't link to a generic Series.sparse location, but I can do
to provide sparse-specific methods like :meth:`Series.sparse.from_coo`.
and people can navigate from there.
There was a problem hiding this comment.
I am fine with the idea of a sparse accessor. I only have some hesitation about some of the attributes exposed there, as this enforces them as public API.
(as I think I already mentioned before, promoting this from SparseSeries to Series is like more officially supporting this as a stable part of pandas).
For example, do we want to expose the IntIndex and BlockIndex officially as API?
| @@ -581,98 +580,13 @@ def combine_first(self, other): | |||
| return dense_combined.to_sparse(fill_value=self.fill_value) | |||
|
|
|||
| def to_coo(self, row_levels=(0, ), column_levels=(1, ), sort_labels=False): | |||
| """ | |||
| Create a scipy.sparse.coo_matrix from a SparseSeries with MultiIndex. | |||
There was a problem hiding this comment.
Can you keep those docstrings here (or share it with the delegate method)
There was a problem hiding this comment.
My hope is to deprecate SparseSeries entirely for 0.24.0. But I suppose we'll want a docstring for the deprecation period, so I'll use shared docs.
I'm happy to remove those. |
|
Forgot to remove sp_index and kind from the api.rst This should be ready once it passes. |
|
thanks @TomAugspurger |
Closes #23148.
This should provide all the methods / attributes that were available on SparseSeries, but not Series.
Right now the docs for
.sparse.from_cooandto_cooseem to be broken. It's a bit strange since they're implemented on the accessor (they don't make sense on the Array)