Skip to content

DOC: explain EWM #34910

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.

Sign up for GitHub

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 9 commits into from
Jun 20, 2020
Merged

DOC: explain EWM #34910

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
3f9f23b
fixed issue #34867
Jun 20, 2020
9784303
pep8: line too long
KrishnaSai2020 Jun 20, 2020
59580b7
Update pandas/core/generic.py
KrishnaSai2020 Jun 20, 2020
07755a0
fixed issue #34867
Jun 20, 2020
bb84b89
fixed issue #34867
Jun 20, 2020
70498be
fixed pep8 issue
Jun 20, 2020
3a4be07
renamed exponentialmoving back to ewm.py
Jun 20, 2020
c37c94b
pep 8 issues
Jun 20, 2020
c970ce2
pep 8 issues
Jun 20, 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
7 changes: 4 additions & 3 deletions pandas/core/generic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10460,7 +10460,8 @@ def _add_series_or_dataframe_operations(cls):
Add the series or dataframe only operations to the cls; evaluate
the doc strings again.
"""
from pandas.core.window import EWM, Expanding, Rolling, Window
from pandas.core.window import ExponentialMovingWindow, Expanding, Rolling
from pandas.core.window import Window

@doc(Rolling)
def rolling(
Expand Down Expand Up @@ -10507,7 +10508,7 @@ def expanding(self, min_periods=1, center=False, axis=0):

cls.expanding = expanding

@doc(EWM)
@doc(ExponentialMovingWindow)
def ewm(
self,
com=None,
Expand All @@ -10520,7 +10521,7 @@ def ewm(
axis=0,
):
axis = self._get_axis_number(axis)
return EWM(
return ExponentialMovingWindow(
self,
com=com,
span=span,
Expand Down
2 changes: 1 addition & 1 deletion pandas/core/window/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
from pandas.core.window.ewm import EWM # noqa:F401
from pandas.core.window.exponentialmovingwindow import ExponentialMovingWindow # noqa:F401
from pandas.core.window.expanding import Expanding, ExpandingGroupby # noqa:F401
from pandas.core.window.rolling import Rolling, RollingGroupby, Window # noqa:F401
4 changes: 2 additions & 2 deletions pandas/core/window/ewm.py → ...as/core/window/exponentialmovingwindow.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ def get_center_of_mass(
return float(comass)


class EWM(_Rolling):
class ExponentialMovingWindow(_Rolling):
r"""
Provide exponential weighted (EW) functions.

Expand Down Expand Up @@ -185,7 +185,7 @@ def __init__(

@property
def _constructor(self):
return EWM
return ExponentialMovingWindow

_agg_see_also_doc = dedent(
"""
Expand Down
4 changes: 2 additions & 2 deletions pandas/tests/window/test_ewm.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
from pandas.errors import UnsupportedFunctionCall

from pandas import DataFrame, Series
from pandas.core.window import EWM
from pandas.core.window import ExponentialMovingWindow


def test_doc_string():
Expand Down Expand Up @@ -56,7 +56,7 @@ def test_constructor(which):
@pytest.mark.parametrize("method", ["std", "mean", "var"])
def test_numpy_compat(method):
# see gh-12811
e = EWM(Series([2, 4, 6]), alpha=0.5)
e = ExponentialMovingWindow(Series([2, 4, 6]), alpha=0.5)

msg = "numpy operations are not valid with window objects"

Expand Down