Skip to main content

GroupBy operations for dask.array

Project description

GitHub Workflow CI Statuspre-commit.ci statusimagePyPIConda-forgeDocumentation StatusNASA-80NSSC18M0156

flox

This project explores strategies for fast GroupBy reductions with dask.array. It used to be called dask_groupby It was motivated by

  1. Dask Dataframe GroupBy blogpost
  2. 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), 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

  1. flox.groupby_reduce(dask_array, by_dask_array, "mean") "pure" dask array interface
  2. flox.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,
    )

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

flox-0.4.1.tar.gz (308.3 kB view details)

Uploaded Source

Built Distribution

flox-0.4.1-py3-none-any.whl (54.1 kB view details)

Uploaded Python 3

File details

Details for the file flox-0.4.1.tar.gz.

File metadata

  • Download URL: flox-0.4.1.tar.gz
  • Upload date:
  • Size: 308.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.2

File hashes

Hashes for flox-0.4.1.tar.gz
Algorithm Hash digest
SHA256 ad8416c75c57f379a143da3639a1325e15577ccf1387dab2ef4dd60419f0a58a
MD5 0cd5cc613657e9654fef0edd5d91b1d1
BLAKE2b-256 2490833aab1ca868a7ad3785de21b4db9af1f3476b940852dc8d053c546cebef

See more details on using hashes here.

File details

Details for the file flox-0.4.1-py3-none-any.whl.

File metadata

  • Download URL: flox-0.4.1-py3-none-any.whl
  • Upload date:
  • Size: 54.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.2

File hashes

Hashes for flox-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b6a3c1fc31983e1bff09ce4de8f4d9d5b95a699922266cea17631f6b84078a83
MD5 f62ea6757f8b65f45f596eb7d1dca8a0
BLAKE2b-256 e78e018356d79de77b130659a9e9ac2feca0469d948214468f10a428dd8152a8

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page