@@ -445,84 +445,6 @@ class providing the base-class of operations.
445
445
see the examples below.
446
446
{examples}"""
447
447
448
- _agg_template_frame = """
449
- Aggregate using one or more operations.
450
-
451
- Parameters
452
- ----------
453
- func : function, str, list, dict or None
454
- Function to use for aggregating the data. If a function, must either
455
- work when passed a {klass} or when passed to {klass}.apply.
456
-
457
- Accepted combinations are:
458
-
459
- - function
460
- - string function name
461
- - list of functions and/or function names, e.g. ``[np.sum, 'mean']``
462
- - dict of index labels -> functions, function names or list of such.
463
- - None, in which case ``**kwargs`` are used with Named Aggregation. Here the
464
- output has one column for each element in ``**kwargs``. The name of the
465
- column is keyword, whereas the value determines the aggregation used to compute
466
- the values in the column.
467
-
468
- Can also accept a Numba JIT function with
469
- ``engine='numba'`` specified. Only passing a single function is supported
470
- with this engine.
471
-
472
- If the ``'numba'`` engine is chosen, the function must be
473
- a user defined function with ``values`` and ``index`` as the
474
- first and second arguments respectively in the function signature.
475
- Each group's index will be passed to the user defined function
476
- and optionally available for use.
477
-
478
- *args
479
- Positional arguments to pass to func.
480
- engine : str, default None
481
- * ``'cython'`` : Runs the function through C-extensions from cython.
482
- * ``'numba'`` : Runs the function through JIT compiled code from numba.
483
- * ``None`` : Defaults to ``'cython'`` or globally setting ``compute.use_numba``
484
-
485
- engine_kwargs : dict, default None
486
- * For ``'cython'`` engine, there are no accepted ``engine_kwargs``
487
- * For ``'numba'`` engine, the engine can accept ``nopython``, ``nogil``
488
- and ``parallel`` dictionary keys. The values must either be ``True`` or
489
- ``False``. The default ``engine_kwargs`` for the ``'numba'`` engine is
490
- ``{{'nopython': True, 'nogil': False, 'parallel': False}}`` and will be
491
- applied to the function
492
-
493
- **kwargs
494
- * If ``func`` is None, ``**kwargs`` are used to define the output names and
495
- aggregations via Named Aggregation. See ``func`` entry.
496
- * Otherwise, keyword arguments to be passed into func.
497
-
498
- Returns
499
- -------
500
- {klass}
501
-
502
- See Also
503
- --------
504
- {klass}.groupby.apply : Apply function func group-wise
505
- and combine the results together.
506
- {klass}.groupby.transform : Transforms the Series on each group
507
- based on the given function.
508
- {klass}.aggregate : Aggregate using one or more operations.
509
-
510
- Notes
511
- -----
512
- When using ``engine='numba'``, there will be no "fall back" behavior internally.
513
- The group data and group index will be passed as numpy arrays to the JITed
514
- user defined function, and no alternative execution attempts will be tried.
515
-
516
- Functions that mutate the passed object can produce unexpected
517
- behavior or errors and are not supported. See :ref:`gotchas.udf-mutation`
518
- for more details.
519
-
520
- .. versionchanged:: 1.3.0
521
-
522
- The resulting dtype will reflect the return value of the passed ``func``,
523
- see the examples below.
524
- {examples}"""
525
-
526
448
527
449
@final
528
450
class GroupByPlot (PandasObject ):
0 commit comments