Merge pull request #60 from Nixtla/ImprovedDocumentation2

Intro paragraph for documentation, tutorial titles, gitignore protect…
Nixtla · Sep 30, 2022 · 94688e7 · 94688e7
2 parents 6f8da06 + dd5edb2
commit 94688e7
Show file tree

Hide file tree

Showing 7 changed files with 11 additions and 8 deletions.
diff --git a/.gitignore b/.gitignore
@@ -27,6 +27,7 @@ share/python-wheels/
 *.egg
 MANIFEST
 
+.last_checked
 .gitattributes
 .gitconfig
 .DS_Store

diff --git a/nbs/examples/AustralianDomesticTourism-Bootstraped-Intervals.ipynb b/nbs/examples/AustralianDomesticTourism-Bootstraped-Intervals.ipynb
@@ -4,7 +4,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Bootstrapped Probabilistic forecasts for Australian domestic tourism"
+    "# 5. Reconciled Probabilistic Forecasts (Bootstrap)"
    ]
   },
   {
@@ -27,7 +27,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "%%capture\n",
+    "%%captureBootstrapped\n",
     "!pip install hierarchicalforecast\n",
     "!pip install -U statsforecast numba statsmodels matplotlib"
    ]

diff --git a/nbs/examples/AustralianDomesticTourism-Intervals.ipynb b/nbs/examples/AustralianDomesticTourism-Intervals.ipynb
@@ -4,7 +4,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Probabilistic forecasts for Australian domestic tourism"
+    "# 4. Reconciled Probabilistic Forecasts (Normality)"
    ]
   },
   {

diff --git a/nbs/examples/AustralianDomesticTourism.ipynb b/nbs/examples/AustralianDomesticTourism.ipynb
@@ -4,7 +4,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Forecasting Australian domestic tourism"
+    "# 2. R's Fable/HTS Replication1"
    ]
   },
   {

diff --git a/nbs/examples/AustralianPrisonPopulation.ipynb b/nbs/examples/AustralianPrisonPopulation.ipynb
@@ -4,7 +4,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Forecasting Australian prison population"
+    "# 3. R's Fable/HTS Replication2"
    ]
   },
   {

diff --git a/nbs/examples/TourismSmall.ipynb b/nbs/examples/TourismSmall.ipynb
@@ -5,7 +5,7 @@
    "id": "843cf8de-d678-4243-a8af-d78439058e6a",
    "metadata": {},
    "source": [
-    "# Hierarchical Reconciliation for TourismSmall dataset"
+    "# 1. Reconciliation Quick Start"
    ]
   },
   {

diff --git a/nbs/index.ipynb b/nbs/index.ipynb
@@ -5,15 +5,17 @@
    "id": "018f6145-b103-4f3e-b4cd-0aab4d8bbdb7",
    "metadata": {},
    "source": [
-    "# Hierarchical 👑 Forecast"
+    "# 👑 Hierarchical Forecast"
    ]
   },
   {
    "cell_type": "markdown",
    "id": "112249bc-95d7-42bd-9eb9-b6bb7dda5b20",
    "metadata": {},
    "source": [
-    "**HierarchicalForecast** offers a collection of reconciliation methods, including `BottomUp`, `TopDown`, `MiddleOut`, `MinTrace` and `ERM`. "
+    "Large collections of time series organized into structures at different aggregation levels often require their forecasts to follow their aggregation constraints, which poses the challenge of creating novel algorithms capable of coherent forecasts.\n",
+    "\n",
+    "**HierarchicalForecast** offers a collection of reconciliation methods, including `BottomUp`, `TopDown`, `MiddleOut`, `MinTrace` and `ERM`. Along with data wrangling, evaluation and visualization tools for grouped and hierarchical series."
    ]
   },
   {