From 2be8821c957a85b56530074fb0375118e67fc51d Mon Sep 17 00:00:00 2001 From: bl Date: Sat, 16 Sep 2017 21:52:17 -0700 Subject: [PATCH] Clarify in documentation the saturating min requires specifying cap --- docs/_docs/saturating_forecasts.md | 4 ++++ notebooks/saturating_forecasts.ipynb | 9 +++++++++ 2 files changed, 13 insertions(+) diff --git a/docs/_docs/saturating_forecasts.md b/docs/_docs/saturating_forecasts.md index 61e577c..b505aa0 100644 --- a/docs/_docs/saturating_forecasts.md +++ b/docs/_docs/saturating_forecasts.md @@ -64,6 +64,8 @@ m.plot(fcst); ![png](/prophet/static/saturating_forecasts_files/saturating_forecasts_13_0.png) +The logistic function has an implicit minimum of 0, and will saturate at 0 the same way that it saturates at the capacity. It is possible to also specify a different saturating minimum. + ### Saturating Minimum The logistic growth model can also handle a saturating minimum, which is specified with a column `floor` in the same way as the `cap` column specifies the maximum: @@ -94,3 +96,5 @@ m.plot(fcst); ![png](/prophet/static/saturating_forecasts_files/saturating_forecasts_16_0.png) + +To use a logistic growth trend with a saturating minimum, a maximum capacity must also be specified. diff --git a/notebooks/saturating_forecasts.ipynb b/notebooks/saturating_forecasts.ipynb index ed5f1cd..7713235 100644 --- a/notebooks/saturating_forecasts.ipynb +++ b/notebooks/saturating_forecasts.ipynb @@ -222,6 +222,8 @@ "cell_type": "markdown", "metadata": {}, "source": [ + "The logistic function has an implicit minimum of 0, and will saturate at 0 the same way that it saturates at the capacity. It is possible to also specify a different saturating minimum.\n", + "\n", "### Saturating Minimum\n", "\n", "The logistic growth model can also handle a saturating minimum, which is specified with a column `floor` in the same way as the `cap` column specifies the maximum:" @@ -294,6 +296,13 @@ "fcst = m.predict(future)\n", "m.plot(fcst);" ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "To use a logistic growth trend with a saturating minimum, a maximum capacity must also be specified." + ] } ], "metadata": {