saymrwulf/prophet
1
0
Fork 0
mirror of https://github.com/saymrwulf/prophet.git synced 2026-07-11 17:48:42 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Adding docstrings to new plotting methods.

Browse source
This commit is contained in:
Isaac Laughlin 2017-03-03 14:21:10 -08:00
parent 13fc5c8ae4
commit 597fce143f
1 changed files with 53 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

54
python/fbprophet/forecaster.py
View file

@ -664,7 +664,20 @@ class Prophet(object):
fig.tight_layout()
return artists
def plot_trend(self, fcst, ax=None, uncertainty=True, **plotargs):
def plot_trend(self, fcst, ax=None, uncertainty=True):
"""Plot the trend component of the forecast.
Parameters
----------
fcst: pd.DataFrame output of self.predict.
ax: Optional matplotlib Axes to plot on.
uncertainty: Optional boolean to plot uncertainty intervals.
Returns
-------
a list of matplotlib artists
"""
artists = []
if not ax:
ax = fig.add_subplot(111)
@ -683,6 +696,19 @@ class Prophet(object):
return artists
def plot_holidays(self, fcst, ax=None, uncertainty=True):
"""Plot the holidays component of the forecast.
Parameters
----------
fcst: pd.DataFrame output of self.predict.
ax: Optional matplotlib Axes to plot on. One will be created if this
is not provided.
uncertainty: Optional boolean to plot uncertainty intervals.
Returns
-------
a list of matplotlib artists
"""
artists = []
if not ax:
ax = fig.add_subplot(111)
@ -706,6 +732,19 @@ class Prophet(object):
return artists
def plot_weekly(self, fcst, ax=None, uncertainty=True):
"""Plot the weekly component of the forecast.
Parameters
----------
fcst: pd.DataFrame output of self.predict.
ax: Optional matplotlib Axes to plot on. One will be created if this
is not provided.
uncertainty: Optional boolean to plot uncertainty intervals.
Returns
-------
a list of matplotlib artists
"""
artists = []
if not ax:
ax = fig.add_subplot(111)
@ -730,6 +769,19 @@ class Prophet(object):
return artists
def plot_yearly(self, fcst, ax=None, uncertainty=True):
"""Plot the yearly component of the forecast.
Parameters
----------
fcst: pd.DataFrame output of self.predict.
ax: Optional matplotlib Axes to plot on. One will be created if
this is not provided.
uncertainty: Optional boolean to plot uncertainty intervals.
Returns
-------
a list of matplotlib artists
"""
artists = []
if not ax:
ax = fig.add_subplot(npanel, 1, panel_num)