Skip to content

Commit 6a811bf

Browse files
committed
Update docstring
1 parent c0cb300 commit 6a811bf

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

flox/core.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1437,13 +1437,14 @@ def groupby_reduce(
14371437
and is identical to xarray's default strategy.
14381438
engine : {"flox", "numpy", "numba"}, optional
14391439
Algorithm to compute the groupby reduction on non-dask arrays and on each dask chunk:
1440+
* ``"numpy"``:
1441+
Use the vectorized implementations in ``numpy_groupies.aggregate_numpy``.
1442+
This is the default choice because it works for most array types.
14401443
* ``"flox"``:
14411444
Use an internal implementation where the data is sorted so that
14421445
all members of a group occur sequentially, and then numpy.ufunc.reduceat
14431446
is to used for the reduction. This will fall back to ``numpy_groupies.aggregate_numpy``
14441447
for a reduction that is not yet implemented.
1445-
* ``"numpy"``:
1446-
Use the vectorized implementations in ``numpy_groupies.aggregate_numpy``.
14471448
* ``"numba"``:
14481449
Use the implementations in ``numpy_groupies.aggregate_numba``.
14491450
reindex : bool, optional

flox/xarray.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -128,13 +128,14 @@ def xarray_reduce(
128128
and is identical to xarray's default strategy.
129129
engine : {"flox", "numpy", "numba"}, optional
130130
Algorithm to compute the groupby reduction on non-dask arrays and on each dask chunk:
131+
* ``"numpy"``:
132+
Use the vectorized implementations in ``numpy_groupies.aggregate_numpy``.
133+
This is the default choice because it works for other array types.
131134
* ``"flox"``:
132135
Use an internal implementation where the data is sorted so that
133136
all members of a group occur sequentially, and then numpy.ufunc.reduceat
134137
is to used for the reduction. This will fall back to ``numpy_groupies.aggregate_numpy``
135138
for a reduction that is not yet implemented.
136-
* ``"numpy"``:
137-
Use the vectorized implementations in ``numpy_groupies.aggregate_numpy``.
138139
* ``"numba"``:
139140
Use the implementations in ``numpy_groupies.aggregate_numba``.
140141
keep_attrs : bool, optional

0 commit comments

Comments
 (0)