-
Notifications
You must be signed in to change notification settings - Fork 917
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Closes #6858. Adds a "GroupBy" page to our docs. Authors: - Ashwin Srinath <[email protected]> Approvers: - Keith Kraus (@kkraus14) URL: #7100
- Loading branch information
Showing
2 changed files
with
169 additions
and
0 deletions.
There are no files selected for viewing
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,168 @@ | ||
GroupBy | ||
======= | ||
|
||
cuDF supports a small (but important) subset of | ||
Pandas' [groupby API](https://pandas.pydata.org/pandas-docs/stable/user_guide/groupby.html). | ||
|
||
## Summary of supported operations | ||
|
||
1. Grouping by one or more columns | ||
1. Basic aggregations such as "sum", "mean", etc. | ||
1. Quantile aggregation | ||
1. A "collect" or `list` aggregation for collecting values in a group into lists | ||
1. Automatic exclusion of columns with unsupported dtypes ("nuisance" columns) when aggregating | ||
1. Iterating over the groups of a GroupBy object | ||
1. `GroupBy.groups` API that returns a mapping of group keys to row labels | ||
1. `GroupBy.apply` API for performing arbitrary operations on each group. Note that | ||
this has very limited functionality compared to the equivalent Pandas function. | ||
See the section on [apply](#groupby-apply) for more details. | ||
1. `GroupBy.pipe` similar to [Pandas](https://pandas.pydata.org/pandas-docs/stable/user_guide/groupby.html#piping-function-calls). | ||
|
||
## Grouping | ||
|
||
A GroupBy object is created by grouping the values of a `Series` or `DataFrame` | ||
by one or more columns: | ||
|
||
```python | ||
import cudf | ||
|
||
>>> df = cudf.DataFrame({'a': [1, 1, 1, 2, 2], 'b': [1, 1, 2, 2, 3], 'c': [1, 2, 3, 4, 5]}) | ||
>>> df | ||
>>> gb1 = df.groupby('a') # grouping by a single column | ||
>>> gb2 = df.groupby(['a', 'b']) # grouping by multiple columns | ||
>>> gb3 = df.groupby(cudf.Series(['a', 'a', 'b', 'b', 'b'])) # grouping by an external column | ||
``` | ||
|
||
### Grouping by index levels | ||
|
||
You can also group by one or more levels of a MultiIndex: | ||
|
||
```python | ||
>>> df = cudf.DataFrame( | ||
... {'a': [1, 1, 1, 2, 2], 'b': [1, 1, 2, 2, 3], 'c': [1, 2, 3, 4, 5]} | ||
... ).set_index(['a', 'b']) | ||
... | ||
>>> df.groupby(level='a') | ||
``` | ||
|
||
### The `Grouper` object | ||
|
||
A `Grouper` can be used to disambiguate between columns and levels when they have the same name: | ||
|
||
```python | ||
>>> df | ||
b c | ||
b | ||
1 1 1 | ||
1 1 2 | ||
1 2 3 | ||
2 2 4 | ||
2 3 5 | ||
>>> df.groupby('b', level='b') # ValueError: Cannot specify both by and level | ||
>>> df.groupby([cudf.Grouper(key='b'), cudf.Grouper(level='b')]) # OK | ||
``` | ||
|
||
## Aggregation | ||
|
||
Aggregations on groups is supported via the `agg` method: | ||
|
||
``` | ||
>>> df | ||
a b c | ||
0 1 1 1 | ||
1 1 1 2 | ||
2 1 2 3 | ||
3 2 2 4 | ||
4 2 3 5 | ||
>>> df.groupby('a').agg('sum') | ||
b c | ||
a | ||
1 4 6 | ||
2 5 9 | ||
>>> df.groupby('a').agg({'b': ['sum', 'min'], 'c': 'mean'}) | ||
b c | ||
sum min mean | ||
a | ||
1 4 1 2.0 | ||
2 5 2 4.5 | ||
``` | ||
|
||
The following table summarizes the available aggregations and the types that support them: | ||
|
||
| Aggregations\dtypes | Numeric | Datetime | String | Categorical | List | Struct | | ||
| ------------------- | -------- | ------- | -------- | ----------- | ---- | ------ | | ||
| count | ✅ | ✅ | ✅ | ✅ | | | | ||
| size | ✅ | ✅ | ✅ | ✅ | | | | ||
| sum | ✅ | ✅ | | | | | | ||
| idxmin | ✅ | ✅ | | | | | | ||
| idxmax | ✅ | ✅ | | | | | | ||
| min | ✅ | ✅ | ✅ | | | | | ||
| max | ✅ | ✅ | ✅ | | | | | ||
| mean | ✅ | ✅ | | | | | | ||
| var | ✅ | ✅ | | | | | | ||
| std | ✅ | ✅ | | | | | | ||
| quantile | ✅ | ✅ | | | | | | ||
| median | ✅ | ✅ | | | | | | ||
| nunique | ✅ | ✅ | ✅ | ✅ | | | | ||
| nth | ✅ | ✅ | ✅ | | | | | ||
| collect | ✅ | ✅ | ✅ | | ✅ | | | ||
|
||
## GroupBy apply | ||
|
||
To apply function on each group, use the `GroupBy.apply()` method: | ||
|
||
```python | ||
>>> df | ||
a b c | ||
0 1 1 1 | ||
1 1 1 2 | ||
2 1 2 3 | ||
3 2 2 4 | ||
4 2 3 5 | ||
>>> df.groupby('a').apply(lambda x: x.max() - x.min()) | ||
a b c | ||
a | ||
0 0 1 2 | ||
1 0 1 1 | ||
``` | ||
|
||
### Limitations | ||
|
||
* `apply` works by applying the provided function to each group sequentially, | ||
and concatenating the results together. **This can be very slow**, especially | ||
for a large number of small groups. For a small number of large groups, it | ||
can give acceptable performance | ||
|
||
* The results may not always match Pandas exactly. For example, cuDF may return | ||
a `DataFrame` containing a single column where Pandas returns a `Series`. | ||
Some post-processing may be required to match Pandas behavior. | ||
|
||
* cuDF does not support some of the exceptional cases that Pandas supports with | ||
`apply`, such as [`describe`](https://pandas.pydata.org/pandas-docs/stable/user_guide/groupby.html#flexible-apply). | ||
|
||
## Rolling window calculations | ||
|
||
Use the `GroupBy.rolling()` method to perform rolling window calculations on each group: | ||
|
||
```python | ||
>>> df | ||
a b c | ||
0 1 1 1 | ||
1 1 1 2 | ||
2 1 2 3 | ||
3 2 2 4 | ||
4 2 3 5 | ||
``` | ||
|
||
Rolling window sum on each group with a window size of 2: | ||
|
||
```python | ||
>>> df.groupby('a').rolling(2).sum() | ||
a b c | ||
a | ||
1 0 <NA> <NA> <NA> | ||
1 2 2 3 | ||
2 2 3 5 | ||
2 3 <NA> <NA> <NA> | ||
4 4 5 9 | ||
``` |
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