pandas.core.window.rolling.Rolling.max#
- Rolling.max(numeric_only=False, *args, engine=None, engine_kwargs=None, **kwargs)[source]#
Calculate the rolling maximum.
- Parameters:
- numeric_onlybool, default False
Include only float, int, boolean columns.
Added in version 1.5.0.
- *argsiterable, optional
Positional arguments passed into
func.- enginestr, default None
'cython': Runs the operation through C-extensions from cython.'numba': Runs the operation through JIT compiled code from numba.None: Defaults to'cython'or globally settingcompute.use_numbaAdded in version 1.3.0.
- engine_kwargsdict, default None
For
'cython'engine, there are no acceptedengine_kwargsFor
'numba'engine, the engine can acceptnopython,nogilandparalleldictionary keys. The values must either beTrueorFalse. The defaultengine_kwargsfor the'numba'engine is{'nopython': True, 'nogil': False, 'parallel': False}Added in version 1.3.0.
- **kwargsmapping, optional
A dictionary of keyword arguments passed into
func.
- Returns:
- Series or DataFrame
Return type is the same as the original object with
np.float64dtype.
See also
Series.rollingCalling rolling with Series data.
DataFrame.rollingCalling rolling with DataFrames.
Series.maxAggregating max for Series.
DataFrame.maxAggregating max for DataFrame.
Notes
See Numba engine and Numba (JIT compilation) for extended documentation and performance considerations for the Numba engine.
Examples
>>> ser = pd.Series([1, 2, 3, 4]) >>> ser.rolling(2).max() 0 NaN 1 2.0 2 3.0 3 4.0 dtype: float64