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.5.5.tar.gz (369.3 kB view details)

Uploaded Source

Built Distribution

flox-0.5.5-py3-none-any.whl (57.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: flox-0.5.5.tar.gz
  • Upload date:
  • Size: 369.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.4

File hashes

Hashes for flox-0.5.5.tar.gz
Algorithm Hash digest
SHA256 4a0389c4a30a9c02c505baa8c3c24e5625a73f66336eb0717caa06c44d3aca41
MD5 198c07ab4de0a5033cdfcfb3c5fc4025
BLAKE2b-256 a2c9cd373952764636195905aed24ab5484fbf593e1b6efe5e0060d71264e53f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: flox-0.5.5-py3-none-any.whl
  • Upload date:
  • Size: 57.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.4

File hashes

Hashes for flox-0.5.5-py3-none-any.whl
Algorithm Hash digest
SHA256 c578925ec7683830bab8572849ed91a10c893620bda6e66a1683c165d61bc304
MD5 999e2879146c50ece5fa28390dfd3c05
BLAKE2b-256 966978d8cbfaac2a54c281f04778d6e21b6dc0d8034bb0edfb3892568dd8aae5

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