modin.pandas.Expanding.sum¶

Expanding.sum(numeric_only: bool = False, engine: Optional[Literal['cython', 'numba']] = None, engine_kwargs: Optional[dict[str, bool]] = None)[source]¶

Compute the expanding sum.

Parameters:

• numeric_only (bool, default False) – Include only float, int, boolean columns.

• None –

• engine (str, default None 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 setting compute.use_numba

  This parameter is ignored in Snowpark pandas. The execution engine will always be Snowflake.

• engine_kwargs (dict, default None None) –

  • For 'cython' engine, there are no accepted engine_kwargs

  • For 'numba' engine, the engine can accept nopython, nogil

    and parallel dictionary keys. The values must either be True or False. The default engine_kwargs for the 'numba' engine is {'nopython': True, 'nogil': False, 'parallel': False}.

  This parameter is ignored in Snowpark pandas. The execution engine will always be Snowflake.

• None –

Returns:

Computed expanding sum of values.

Return type:

Series or DataFrame

Examples

>>> df = pd.DataFrame({'B': [0, 1, 2, np.nan, 4]})
>>> df
     B
0  0.0
1  1.0
2  2.0
3  NaN
4  4.0
>>> df.expanding(2).sum()
     B
0  NaN
1  1.0
2  3.0
3  3.0
4  7.0

Copy