GroupBy operations for dask.array
Project description
flox
This project explores strategies for fast GroupBy reductions with dask.array. It used to be called dask_groupby
It was motivated by
- Dask Dataframe GroupBy blogpost
- numpy_groupies in Xarray issue
(See a presentation about this package, from the Pangeo Showcase).
Acknowledgements
This work was funded in part by
- NASA-ACCESS 80NSSC18M0156 "Community tools for analysis of NASA Earth Observing System Data in the Cloud" (PI J. Hamman, NCAR),
- NASA-OSTFL 80NSSC22K0345 "Enhancing analysis of NASA data with the open-source Python Xarray Library" (PIs Scott Henderson, University of Washington; Deepak Cherian, NCAR; Jessica Scheick, University of New Hampshire), and
- NCAR's Earth System Data Science Initiative.
It was motivated by very very many discussions in the Pangeo community.
API
There are two main functions
flox.groupby_reduce(dask_array, by_dask_array, "mean")"pure" dask array interfaceflox.xarray.xarray_reduce(xarray_object, by_dataarray, "mean")"pure" xarray interface; though work is ongoing to integrate this package in xarray.
Implementation
See the documentation for details on the implementation.
Custom reductions
flox implements all common reductions provided by numpy_groupies in aggregations.py.
It also allows you to specify a custom Aggregation (again inspired by dask.dataframe),
though this might not be fully functional at the moment. See aggregations.py for examples.
mean = Aggregation(
# name used for dask tasks
name="mean",
# operation to use for pure-numpy inputs
numpy="mean",
# blockwise reduction
chunk=("sum", "count"),
# combine intermediate results: sum the sums, sum the counts
combine=("sum", "sum"),
# generate final result as sum / count
finalize=lambda sum_, count: sum_ / count,
# Used when "reindexing" at combine-time
fill_value=0,
# Used when any member of `expected_groups` is not found
final_fill_value=np.nan,
)
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file flox-0.9.7.tar.gz.
File metadata
- Download URL: flox-0.9.7.tar.gz
- Upload date:
- Size: 654.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | baa7c0aa9b2836f5cf1b283ce918cf3d61dc9ff0af8bda026a598ba5cc0b7c68 |
|
| MD5 | 50d584e9c8d08aef60143b9f228840c7 |
|
| BLAKE2b-256 | 5acce1b9303e2f352d5f6fcc757ecc58af2ce854918ed6a2b3f7d60d23345b9f |
File details
Details for the file flox-0.9.7-py3-none-any.whl.
File metadata
- Download URL: flox-0.9.7-py3-none-any.whl
- Upload date:
- Size: 64.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 0e15d678c5f3d46fe5c6481519d01ceae40a111133b110e80f3b274881af8497 |
|
| MD5 | 6d8b4e3a3ee126ec629e7bb2447c4e45 |
|
| BLAKE2b-256 | 13e1dd5ef0c3bc02f515d84b34b74aa66cd36301b7726e63377f2e7499e393f0 |
