@@ -364,70 +364,6 @@ class providing the base-class of operations.
364364--------
365365%(example)s"""
366366
367- _agg_template_frame = """
368- Aggregate using one or more operations.
369- Parameters
370- ----------
371- func : function, str, list, dict or None
372- Function to use for aggregating the data. If a function, must either
373- work when passed a {klass} or when passed to {klass}.apply.
374- Accepted combinations are:
375- - function
376- - string function name
377- - list of functions and/or function names, e.g. ``[np.sum, 'mean']``
378- - dict of index labels -> functions, function names or list of such.
379- - None, in which case ``**kwargs`` are used with Named Aggregation. Here the
380- output has one column for each element in ``**kwargs``. The name of the
381- column is keyword, whereas the value determines the aggregation used to compute
382- the values in the column.
383- Can also accept a Numba JIT function with
384- ``engine='numba'`` specified. Only passing a single function is supported
385- with this engine.
386- If the ``'numba'`` engine is chosen, the function must be
387- a user defined function with ``values`` and ``index`` as the
388- first and second arguments respectively in the function signature.
389- Each group's index will be passed to the user defined function
390- and optionally available for use.
391- *args
392- Positional arguments to pass to func.
393- engine : str, default None
394- * ``'cython'`` : Runs the function through C-extensions from cython.
395- * ``'numba'`` : Runs the function through JIT compiled code from numba.
396- * ``None`` : Defaults to ``'cython'`` or globally setting ``compute.use_numba``
397- engine_kwargs : dict, default None
398- * For ``'cython'`` engine, there are no accepted ``engine_kwargs``
399- * For ``'numba'`` engine, the engine can accept ``nopython``, ``nogil``
400- and ``parallel`` dictionary keys. The values must either be ``True`` or
401- ``False``. The default ``engine_kwargs`` for the ``'numba'`` engine is
402- ``{{'nopython': True, 'nogil': False, 'parallel': False}}`` and will be
403- applied to the function
404- **kwargs
405- * If ``func`` is None, ``**kwargs`` are used to define the output names and
406- aggregations via Named Aggregation. See ``func`` entry.
407- * Otherwise, keyword arguments to be passed into func.
408- Returns
409- -------
410- {klass}
411- See Also
412- --------
413- {klass}.groupby.apply : Apply function func group-wise
414- and combine the results together.
415- {klass}.groupby.transform : Transforms the Series on each group
416- based on the given function.
417- {klass}.aggregate : Aggregate using one or more operations.
418- Notes
419- -----
420- When using ``engine='numba'``, there will be no "fall back" behavior internally.
421- The group data and group index will be passed as numpy arrays to the JITed
422- user defined function, and no alternative execution attempts will be tried.
423- Functions that mutate the passed object can produce unexpected
424- behavior or errors and are not supported. See :ref:`gotchas.udf-mutation`
425- for more details.
426- .. versionchanged:: 1.3.0
427- The resulting dtype will reflect the return value of the passed ``func``,
428- see the examples below.
429- {examples}"""
430-
431367
432368@final
433369class GroupByPlot (PandasObject ):
0 commit comments