Skip to content

DOC: Add windows.rst #37575

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 24 commits into from
Nov 14, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
248c8db
Make dedicated window.rst page
Oct 23, 2020
824ac5a
Merge remote-tracking branch 'upstream/master' into doc/rolling_rst
Oct 25, 2020
82c681b
Finishing touches to window.rst
Oct 25, 2020
59e7c6e
fix some references
Oct 25, 2020
93e16b1
Merge remote-tracking branch 'upstream/master' into doc/rolling_rst
Nov 2, 2020
280ca79
Add more references
Nov 2, 2020
a3a25d3
Modifications after rendering
Nov 2, 2020
3c60c83
Merge remote-tracking branch 'upstream/master' into doc/rolling_rst
Nov 2, 2020
6d4ad96
Maybe address linting errors?
Nov 2, 2020
c001aac
Ignore another code
Nov 3, 2020
327a42a
Merge remote-tracking branch 'upstream/master' into doc/rolling_rst
Nov 3, 2020
1015dec
Change some references
Nov 3, 2020
2bb5276
Fix another broken reference in enhancingperf
Nov 3, 2020
a332bee
Add window to user_guide/index
Nov 4, 2020
4c017e6
Merge remote-tracking branch 'upstream/master' into doc/rolling_rst
Nov 4, 2020
6004c94
Merge remote-tracking branch 'upstream/master' into doc/rolling_rst
Nov 4, 2020
b97d89d
Fix example
Nov 4, 2020
a191bfb
Merge remote-tracking branch 'upstream/master' into doc/rolling_rst
Nov 5, 2020
d425f0f
Merge remote-tracking branch 'upstream/master' into doc/rolling_rst
Nov 6, 2020
332a278
Merge remote-tracking branch 'upstream/master' into doc/rolling_rst
Nov 10, 2020
afa7246
Merge remote-tracking branch 'upstream/master' into doc/rolling_rst
Nov 11, 2020
30d5b8e
Merge remote-tracking branch 'upstream/master' into doc/rolling_rst
Nov 12, 2020
6ee7a87
Merge remote-tracking branch 'upstream/master' into doc/rolling_rst
Nov 14, 2020
51cc93e
Merge remote-tracking branch 'upstream/master' into doc/rolling_rst
Nov 14, 2020
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 22 additions & 6 deletions doc/source/reference/window.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,10 @@ Rolling objects are returned by ``.rolling`` calls: :func:`pandas.DataFrame.roll
Expanding objects are returned by ``.expanding`` calls: :func:`pandas.DataFrame.expanding`, :func:`pandas.Series.expanding`, etc.
ExponentialMovingWindow objects are returned by ``.ewm`` calls: :func:`pandas.DataFrame.ewm`, :func:`pandas.Series.ewm`, etc.

Standard moving window functions
--------------------------------
.. _api.functions_rolling:

Rolling window functions
------------------------
.. currentmodule:: pandas.core.window.rolling

.. autosummary::
Expand All @@ -33,15 +35,25 @@ Standard moving window functions
Rolling.aggregate
Rolling.quantile
Rolling.sem

.. _api.functions_window:

Weighted window functions
-------------------------
.. currentmodule:: pandas.core.window.rolling

.. autosummary::
:toctree: api/

Window.mean
Window.sum
Window.var
Window.std

.. _api.functions_expanding:

Standard expanding window functions
-----------------------------------
Expanding window functions
--------------------------
.. currentmodule:: pandas.core.window.expanding

.. autosummary::
Expand All @@ -64,8 +76,10 @@ Standard expanding window functions
Expanding.quantile
Expanding.sem

Exponentially-weighted moving window functions
----------------------------------------------
.. _api.functions_ewm:

Exponentially-weighted window functions
---------------------------------------
.. currentmodule:: pandas.core.window.ewm

.. autosummary::
Expand All @@ -77,6 +91,8 @@ Exponentially-weighted moving window functions
ExponentialMovingWindow.corr
ExponentialMovingWindow.cov

.. _api.indexers_window:

Window indexer
--------------
.. currentmodule:: pandas
Expand Down
6 changes: 3 additions & 3 deletions doc/source/user_guide/basics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -538,8 +538,8 @@ standard deviation of 1), very concisely:

Note that methods like :meth:`~DataFrame.cumsum` and :meth:`~DataFrame.cumprod`
preserve the location of ``NaN`` values. This is somewhat different from
:meth:`~DataFrame.expanding` and :meth:`~DataFrame.rolling`.
For more details please see :ref:`this note <stats.moments.expanding.note>`.
:meth:`~DataFrame.expanding` and :meth:`~DataFrame.rolling` since ``NaN`` behavior
is furthermore dictated by a ``min_periods`` parameter.

.. ipython:: python

Expand Down Expand Up @@ -945,7 +945,7 @@ Aggregation API

The aggregation API allows one to express possibly multiple aggregation operations in a single concise way.
This API is similar across pandas objects, see :ref:`groupby API <groupby.aggregate>`, the
:ref:`window functions API <stats.aggregate>`, and the :ref:`resample API <timeseries.aggregate>`.
:ref:`window API <window.overview>`, and the :ref:`resample API <timeseries.aggregate>`.
The entry point for aggregation is :meth:`DataFrame.aggregate`, or the alias
:meth:`DataFrame.agg`.

Expand Down
Loading