[Docs] update website to 1.0.0rc8 (#1538)

* update contents.rst first paragraph * remove deprecated check_nblink_files.py * add Mlflow * update main contents.rst * improve main page * update conf contents * update conf contents 2 * update notebooks * include whole codebase
ourownstory · Feb 20, 2024 · 6906ee8 · 6906ee8
1 parent 5a3fabf
commit 6906ee8
Show file tree

Hide file tree

Showing 26 changed files with 488 additions and 714 deletions.
diff --git a/docs/check_nblink_files.py b/docs/check_nblink_files.py
diff --git a/docs/source/code/components/base.rst b/docs/source/code/components/base.rst
@@ -0,0 +1,5 @@
+Core Module Documentation
+==========================
+
+.. automodule:: neuralprophet.components.base
+   :members:
diff --git a/docs/source/code/components/future_regressors/index.rst b/docs/source/code/components/future_regressors/index.rst
@@ -0,0 +1,17 @@
+Core Module Documentation
+==========================
+
+.. automodule:: neuralprophet.components.future_regressors.base
+   :members:
+
+.. automodule:: neuralprophet.components.future_regressors.linear
+   :members:
+
+.. automodule:: neuralprophet.components.future_regressors.neural_nets
+   :members:
+
+.. automodule:: neuralprophet.components.future_regressors.shared_neural_nets_coef
+   :members:
+
+.. automodule:: neuralprophet.components.future_regressors.shared_neural_nets
+   :members:
diff --git a/docs/source/code/components/router.rst b/docs/source/code/components/router.rst
@@ -0,0 +1,5 @@
+Core Module Documentation
+==========================
+
+.. automodule:: neuralprophet.components.router
+   :members:
diff --git a/docs/source/code/components/seasonality/index.rst b/docs/source/code/components/seasonality/index.rst
@@ -0,0 +1,8 @@
+Core Module Documentation
+==========================
+
+.. automodule:: neuralprophet.components.seasonality.base
+   :members:
+
+.. automodule:: neuralprophet.components.seasonality.fourier
+   :members:
diff --git a/docs/source/code/components/trend/index.rst b/docs/source/code/components/trend/index.rst
@@ -0,0 +1,14 @@
+Core Module Documentation
+==========================
+
+.. automodule:: neuralprophet.components.trend.base
+   :members:
+
+.. automodule:: neuralprophet.components.trend.linear
+   :members:
+
+.. automodule:: neuralprophet.components.trend.piecewise_linear
+   :members:
+
+.. automodule:: neuralprophet.components.trend.static
+   :members:
diff --git a/docs/source/code/custom_loss_metrics.rst b/docs/source/code/custom_loss_metrics.rst
@@ -0,0 +1,5 @@
+Core Module Documentation
+==========================
+
+.. automodule:: neuralprophet.custom_loss_metrics
+   :members:
diff --git a/docs/source/code/data/process.rst b/docs/source/code/data/process.rst
@@ -0,0 +1,5 @@
+Core Module Documentation
+==========================
+
+.. automodule:: neuralprophet.data.process
+   :members:
diff --git a/docs/source/code/event_utils.rst → docs/source/code/data/split.rst b/docs/source/code/event_utils.rst → docs/source/code/data/split.rst
@@ -1,5 +1,5 @@
 Core Module Documentation
 ==========================
 
-.. automodule:: neuralprophet.event_utils
+.. automodule:: neuralprophet.data.split
    :members:
diff --git a/docs/source/code/data/transform.rst b/docs/source/code/data/transform.rst
@@ -0,0 +1,5 @@
+Core Module Documentation
+==========================
+
+.. automodule:: neuralprophet.data.transform
+   :members:
diff --git a/docs/source/code/forecaster.rst b/docs/source/code/forecaster.rst
@@ -1,20 +1,5 @@
-Core Module Documentation
-==========================
-
-.. toctree::
-   :hidden:
-   :maxdepth: 1
-
-   configure.py <configure>
-   df_utils.py <df_utils>
-   hdays_utils.py <hdays_utils>
-   plot_forecast_plotly.py <plot_forecast_plotly>
-   plot_forecast_matplotlib.py <plot_forecast_matplotlib>
-   plot_model_parameters_plotly.py <plot_model_parameters_plotly>
-   plot_model_parameters_matplotlib.py <plot_model_parameters_matplotlib>
-   time_dataset.py <time_dataset>
-   time_net.py <time_net>
-   utils.py <utils>
+NeuralProphet Class
+-----------------------
 
 .. automodule:: neuralprophet.forecaster
    :members:
diff --git a/docs/source/code/index.rst b/docs/source/code/index.rst
@@ -0,0 +1,38 @@
+Code Documentation
+==========================
+
+.. toctree::
+   :maxdepth: 1
+
+   forecaster.py (NeuralProphet) <forecaster>
+   configure.py <configure>
+   time_dataset.py <time_dataset>
+   time_net.py <time_net>
+   torch_prophet.py <torch_prophet>
+   uncertainty.py <uncertainty>
+   data/process.py <data/process>
+   data/split.py <data/split>
+   data/transform.py <data/transform>
+   components/router.py <components/router>
+   components/base.py <components/base>
+   components/future_regressors <components/future_regressors/index>
+   components/seasonality <components/seasonality/index>
+   components/trend <components/trend/index>
+   plot_forecast_plotly.py <plot_forecast_plotly>
+   plot_forecast_matplotlib.py <plot_forecast_matplotlib>
+   plot_model_parameters_plotly.py <plot_model_parameters_plotly>
+   plot_model_parameters_matplotlib.py <plot_model_parameters_matplotlib>
+   utils.py <utils>
+   df_utils.py <df_utils>
+   hdays_utils.py <hdays_utils>
+   plot_utils.py <plot_utils>
+   utils_metrics.py <utils_metrics>
+   utils_torch.py <utils_torch>
+   custom_loss_metrics.py <custom_loss_metrics>
+   logger.py <logger>
+   np_types.py <np_types>
+
+
+
+
+
diff --git a/docs/source/code/logger.rst b/docs/source/code/logger.rst
@@ -0,0 +1,5 @@
+Core Module Documentation
+==========================
+
+.. automodule:: neuralprophet.logger
+   :members:
diff --git a/docs/source/code/np_types.rst b/docs/source/code/np_types.rst
@@ -0,0 +1,5 @@
+Core Module Documentation
+==========================
+
+.. automodule:: neuralprophet.np_types
+   :members:
diff --git a/docs/source/code/plot_utils.rst b/docs/source/code/plot_utils.rst
@@ -0,0 +1,5 @@
+Core Module Documentation
+==========================
+
+.. automodule:: neuralprophet.plot_utils
+   :members:
diff --git a/docs/source/code/torch_prophet.rst b/docs/source/code/torch_prophet.rst
@@ -0,0 +1,5 @@
+Core Module Documentation
+==========================
+
+.. automodule:: neuralprophet.torch_prophet
+   :members:
diff --git a/docs/source/code/uncertainty.rst b/docs/source/code/uncertainty.rst
@@ -0,0 +1,5 @@
+Core Module Documentation
+==========================
+
+.. automodule:: neuralprophet.uncertainty
+   :members:
diff --git a/docs/source/code/utils_metrics.rst b/docs/source/code/utils_metrics.rst
@@ -0,0 +1,5 @@
+Core Module Documentation
+==========================
+
+.. automodule:: neuralprophet.utils_metrics
+   :members:
diff --git a/docs/source/code/utils_torch.rst b/docs/source/code/utils_torch.rst
@@ -0,0 +1,5 @@
+Core Module Documentation
+==========================
+
+.. automodule:: neuralprophet.utils_torch
+   :members:
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -26,9 +26,10 @@
 # -- Project information -----------------------------------------------------
 
 project = "NeuralProphet"
-copyright = "2021, Oskar Triebe"
+copyright = "2024, Oskar Triebe"
 author = "Oskar Triebe"
-
+version = "1.0.0"
+release = "1.0.0rc8"
 
 # -- General configuration ---------------------------------------------------
 
@@ -54,6 +55,7 @@
 }
 
 # Add any paths that contain templates here, relative to this directory.
+# Note: in use for custom sidebar and landing page
 templates_path = ["_templates"]
 
 # List of patterns, relative to source directory, that match files and
@@ -102,9 +104,11 @@
 ]
 
 # change index.rst to contents.rst for custom landing page feature
-master_doc = "contents"
+root_doc = "contents"
 
-html_additional_pages = {"index": "index.html"}
+html_additional_pages = {
+    "index": "index.html",
+}
 
 
 def setup(app):

diff --git a/docs/source/contents.rst b/docs/source/contents.rst
@@ -7,37 +7,39 @@
 NeuralProphet
 =========================================
 
-Based on Neural Networks, inspired by `Facebook Prophet <https://github.com/facebook/prophet>`_ and `AR-Net <https://github.com/ourownstory/AR-Net>`_, built on Pytorch.
+Fusing traditional time series algorithms using standard deep learning methods, built on PyTorch, inspired by `Facebook Prophet <https://github.com/facebook/prophet>`_ and `AR-Net <https://github.com/ourownstory/AR-Net>`_.
 
 
-Links
------
+Simple Example
+------------------
 
-- `Read the paper <https://arxiv.org/abs/2111.15397?fbclid=IwAR2vCkHYiy5yuPPjWXpJgAJs-uD5NkH4liORt1ch4a6X_kmpMqagGtXyez4>`_
-- `GitHub repository <https://github.com/ourownstory/neural_prophet>`_
+.. code-block:: pycon
+
+    >>> from neuralprophet import NeuralProphet
+    >>> m = NeuralProphet()
+    >>> metrics = m.fit(df)
+    >>> forecast = m.predict(df)
+    >>> m.plot(forecast)
 
-Why NeuralProphet?
+Features
 ------------------
 
-NeuralProphet changes the way time series modelling and forecasting is done:
+NeuralProphet provides many time series modeling and workflow features, in a simple package:
 
-- Support for auto-regression and covariates.
+- Support for global modeling of many time series.
 - Automatic selection of training related hyperparameters.
-- Fourier term seasonality at different periods such as yearly, daily, weekly, hourly.
-- Piecewise linear trend with optional automatic changepoint detection.
-- Plotting for forecast components, model coefficients and final predictions.
-- Support for global modeling.
-- Lagged and future regressors.
-- Sparsity of coefficients through regularization.
-- User-friendly and powerful Python package:
+- Plotting utilities for forecast components, model coefficients and final predictions.
+- Local context through Autoregression and lagged covariates.
+- Changing trends and smooth seasonality at different periods.
+- Modeling of event, holiday, and future regressor effects.
+- Many customization options, such as regularization.
 
-.. code-block:: pycon
+Resources
+-----------------
+
+- `Read the paper <https://arxiv.org/abs/2111.15397?fbclid=IwAR2vCkHYiy5yuPPjWXpJgAJs-uD5NkH4liORt1ch4a6X_kmpMqagGtXyez4>`_
+- `GitHub repository <https://github.com/ourownstory/neural_prophet>`_
 
-    >>> from neuralprophet import NeuralProphet
-    >>> m = NeuralProphet()
-    >>> metrics = m.fit(your_df, freq='D')
-    >>> forecast = m.predict(your_df)
-    >>> m.plot(forecast)
 
 .. toctree::
     :hidden:
@@ -63,23 +65,24 @@ NeuralProphet changes the way time series modelling and forecasting is done:
 .. toctree::
     :hidden:
     :maxdepth: 1
-    :caption: The Science Behind
+    :caption: Code Documentation
 
-    Model Overview<science-behind/model-overview>
-    Presentation<https://github.com/ourownstory/neural_prophet/raw/61f1c6d4667db19a189e15037eb230ee5e90b80c/notes/NeuralProphet_Introduction.pdf>
+    NeuralProphet <code/index>
 
 .. toctree::
     :hidden:
     :maxdepth: 1
-    :caption: API Reference
+    :caption: About
 
-    forecaster.py <code/forecaster>
+    Model Overview<science-behind/model-overview>
+    Presentation<https://github.com/ourownstory/neural_prophet/raw/61f1c6d4667db19a189e15037eb230ee5e90b80c/notes/NeuralProphet_Introduction.pdf>
 
 .. toctree::
     :hidden:
     :maxdepth: 1
     :caption: Community
 
-    Contribution<community/contribute>
-    GitHub <https://github.com/ourownstory/neural_prophet>
-    Slack <https://join.slack.com/t/neuralprophet/shared_invite/zt-1iyfs2pld-vtnegAX4CtYg~6E~V8miXw>
+    Contribute<community/contribute>
+    GitHub<https://github.com/ourownstory/neural_prophet>
+    Slack<https://join.slack.com/t/neuralprophet/shared_invite/zt-1iyfs2pld-vtnegAX4CtYg~6E~V8miXw>
+
diff --git a/docs/source/how-to-guides/feature-guides/global_local_modeling.ipynb b/docs/source/how-to-guides/feature-guides/global_local_modeling.ipynb