fix_naming_and_order

Nixtla · Apr 30, 2024 · 98b625d · 98b625d
1 parent 4ff49cb
commit 98b625d
Show file tree

Hide file tree

Showing 30 changed files with 41 additions and 63 deletions.
diff --git a/nbs/docs/1_getting_started/quickstart.ipynb → ...docs/1_getting_started/2_quickstart.ipynb b/nbs/docs/1_getting_started/quickstart.ipynb → ...docs/1_getting_started/2_quickstart.ipynb
diff --git a/...ing_started/setting_up_your_api_key.ipynb → ...g_started/3_setting_up_your_api_key.ipynb b/...ing_started/setting_up_your_api_key.ipynb → ...g_started/3_setting_up_your_api_key.ipynb
@@ -22,7 +22,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "<img src=\"api_key_process.png\" alt=\"Figure 1. API key set up process\" width=\"600\">"
+    "<img src=\"../../img/api_key_process.png\" alt=\"Figure 1. API key set up process\" width=\"600\">"
    ]
   },
   {

diff --git a/nbs/docs/1_getting_started/faqs.ipynb → nbs/docs/1_getting_started/7_faqs.ipynb b/nbs/docs/1_getting_started/faqs.ipynb → nbs/docs/1_getting_started/7_faqs.ipynb
diff --git a/nbs/docs/2_capabilities/1_overview.ipynb b/nbs/docs/2_capabilities/1_overview.ipynb
@@ -0,0 +1,12 @@
+{
+ "cells": [],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "python3",
+   "language": "python",
+   "name": "python3"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}
diff --git a/...lities/anomaly_detection/quickstart.ipynb → ...ties/anomaly_detection/1_quickstart.ipynb b/...lities/anomaly_detection/quickstart.ipynb → ...ties/anomaly_detection/1_quickstart.ipynb
@@ -5,7 +5,7 @@
    "id": "6de758ee-a0d2-4b3f-acff-eed419dd17c5",
    "metadata": {},
    "source": [
-    "# Quickstart"
+    "# Quickstart Anomaly Detection"
    ]
   },
   {

diff --git a/.../2_capabilities/forecast/quickstart.ipynb → ..._capabilities/forecast/1_quickstart.ipynb b/.../2_capabilities/forecast/quickstart.ipynb → ..._capabilities/forecast/1_quickstart.ipynb
@@ -5,7 +5,7 @@
    "id": "6ecd9d32-9178-4768-bffa-d70c93c98311",
    "metadata": {},
    "source": [
-    "# Quickstart\n",
+    "# Quickstart Forecast\n",
     "\n",
     "Nixtla's TimeGPT is a generative pre-trained forecasting model for time series data. TimeGPT can produce accurate forecasts for new time series without training, using only historical values as inputs. \n",
     "\n",

diff --git a/nbs/docs/2_capabilities/overview.ipynb b/nbs/docs/2_capabilities/overview.ipynb
diff --git a/nbs/docs/3_deployment/azure_ai.ipynb → nbs/docs/3_deployment/2_azure_ai.ipynb b/nbs/docs/3_deployment/azure_ai.ipynb → nbs/docs/3_deployment/2_azure_ai.ipynb
diff --git a/...ntification_with_quantile_forecasts.ipynb → ...ntification_with_quantile_forecasts.ipynb b/...ntification_with_quantile_forecasts.ipynb → ...ntification_with_quantile_forecasts.ipynb
diff --git a/...ification_with_prediction_intervals.ipynb → ...ification_with_prediction_intervals.ipynb b/...ification_with_prediction_intervals.ipynb → ...ification_with_prediction_intervals.ipynb
diff --git a/...cs/4_tutorials/irregular_timestamps.ipynb → ...4_tutorials/12_irregular_timestamps.ipynb b/...cs/4_tutorials/irregular_timestamps.ipynb → ...4_tutorials/12_irregular_timestamps.ipynb
diff --git a/nbs/docs/4_tutorials/bounded_forecasts.ipynb → ...cs/4_tutorials/13_bounded_forecasts.ipynb b/nbs/docs/4_tutorials/bounded_forecasts.ipynb → ...cs/4_tutorials/13_bounded_forecasts.ipynb
diff --git a/..._tutorials/hierarchical_forecasting.ipynb → ...torials/14_hierarchical_forecasting.ipynb b/..._tutorials/hierarchical_forecasting.ipynb → ...torials/14_hierarchical_forecasting.ipynb
diff --git a/...docs/4_tutorials/computing_at_scale.ipynb → ...s/4_tutorials/15_computing_at_scale.ipynb b/...docs/4_tutorials/computing_at_scale.ipynb → ...s/4_tutorials/15_computing_at_scale.ipynb
diff --git a/...omputing_at_scale_spark_distributed.ipynb → ...omputing_at_scale_spark_distributed.ipynb b/...omputing_at_scale_spark_distributed.ipynb → ...omputing_at_scale_spark_distributed.ipynb
diff --git a/...computing_at_scale_dask_distributed.ipynb → ...computing_at_scale_dask_distributed.ipynb b/...computing_at_scale_dask_distributed.ipynb → ...computing_at_scale_dask_distributed.ipynb
diff --git a/.../computing_at_scale_ray_distributed.ipynb → ..._computing_at_scale_ray_distributed.ipynb b/.../computing_at_scale_ray_distributed.ipynb → ..._computing_at_scale_ray_distributed.ipynb
diff --git a/...ocs/4_tutorials/exogenous_variables.ipynb → ...s/4_tutorials/1_exogenous_variables.ipynb b/...ocs/4_tutorials/exogenous_variables.ipynb → ...s/4_tutorials/1_exogenous_variables.ipynb
diff --git a/nbs/docs/4_tutorials/holidays.ipynb → nbs/docs/4_tutorials/2_holidays.ipynb b/nbs/docs/4_tutorials/holidays.ipynb → nbs/docs/4_tutorials/2_holidays.ipynb
diff --git a/...s/4_tutorials/categorical_variables.ipynb → ...4_tutorials/3_categorical_variables.ipynb b/...s/4_tutorials/categorical_variables.ipynb → ...4_tutorials/3_categorical_variables.ipynb
diff --git a/nbs/docs/4_tutorials/longhorizon.ipynb → nbs/docs/4_tutorials/4_longhorizon.ipynb b/nbs/docs/4_tutorials/longhorizon.ipynb → nbs/docs/4_tutorials/4_longhorizon.ipynb
diff --git a/nbs/docs/4_tutorials/multiple_series.ipynb → nbs/docs/4_tutorials/5_multiple_series.ipynb b/nbs/docs/4_tutorials/multiple_series.ipynb → nbs/docs/4_tutorials/5_multiple_series.ipynb
diff --git a/nbs/docs/4_tutorials/finetuning.ipynb → nbs/docs/4_tutorials/6_finetuning.ipynb b/nbs/docs/4_tutorials/finetuning.ipynb → nbs/docs/4_tutorials/6_finetuning.ipynb
diff --git a/..._tutorials/loss_function_finetuning.ipynb → ...utorials/7_loss_function_finetuning.ipynb b/..._tutorials/loss_function_finetuning.ipynb → ...utorials/7_loss_function_finetuning.ipynb
diff --git a/nbs/docs/4_tutorials/cross_validation.ipynb → ...docs/4_tutorials/8_cross_validation.ipynb b/nbs/docs/4_tutorials/cross_validation.ipynb → ...docs/4_tutorials/8_cross_validation.ipynb
diff --git a/...ocs/4_tutorials/historical_forecast.ipynb → ...s/4_tutorials/9_historical_forecast.ipynb b/...ocs/4_tutorials/historical_forecast.ipynb → ...s/4_tutorials/9_historical_forecast.ipynb
diff --git a/...5_use_cases/forecasting_web_traffic.ipynb → ...use_cases/1_forecasting_web_traffic.ipynb b/...5_use_cases/forecasting_web_traffic.ipynb → ...use_cases/1_forecasting_web_traffic.ipynb
diff --git a/..._use_cases/bitcoin_price_prediction.ipynb → ...se_cases/2_bitcoin_price_prediction.ipynb b/..._use_cases/bitcoin_price_prediction.ipynb → ...se_cases/2_bitcoin_price_prediction.ipynb
diff --git a/...ocs/1_getting_started/api_key_process.png → nbs/img/api_key_process.png b/...ocs/1_getting_started/api_key_process.png → nbs/img/api_key_process.png
diff --git a/nbs/mint.json b/nbs/mint.json
@@ -27,9 +27,9 @@
     {
       "group": "Getting Started",
       "pages": [
-        "docs/1_getting_started/quickstart.html",
-        "docs/1_getting_started/setting_up_your_api_key.html",
-        "docs/1_getting_started/faqs.html"      
+        "docs/1_getting_started/2_quickstart.html",
+        "docs/1_getting_started/3_setting_up_your_api_key.html",
+        "docs/1_getting_started/7_faqs.html"      
       ]
     },
     {
@@ -38,21 +38,21 @@
         {
           "group": "Forecast",
           "pages": [
-            "docs/2_capabilities/forecast/quickstart.html"
+            "docs/2_capabilities/forecast/1_quickstart.html"
           ]
         },
         {
           "group": "Anomaly Detection",
           "pages": [
-            "docs/2_capabilities/anomaly_detection/quickstart.html"
+            "docs/2_capabilities/anomaly_detection/1_quickstart.html"
           ]
         }
       ]
     },    
     {
       "group": "Deployment",
       "pages": [
-        "docs/3_deployment/azure_ai.html"
+        "docs/3_deployment/2_azure_ai.html"
       ]
     },
     {
@@ -61,63 +61,63 @@
         {
           "group":"Exogenous variables",
           "pages":[
-            "docs/4_tutorials/holidays.html",
-            "docs/4_tutorials/exogenous_variables.html", 
-            "docs/4_tutorials/categorical_variables.html"
+            "docs/4_tutorials/1_exogenous_variables.html", 
+            "docs/4_tutorials/2_holidays.html",
+            "docs/4_tutorials/3_categorical_variables.html"
           ]
         },
         {
           "group":"Training",
           "pages":[
-            "docs/4_tutorials/longhorizon.html",
-            "docs/4_tutorials/multiple_series.html"
+            "docs/4_tutorials/4_longhorizon.html",
+            "docs/4_tutorials/5_multiple_series.html"
           ]
         },
         {
           "group":"Fine-tuning",
           "pages":[
-            "docs/4_tutorials/finetuning.html",
-            "docs/4_tutorials/loss_function_finetuning.html"
+            "docs/4_tutorials/6_finetuning.html",
+            "docs/4_tutorials/7_loss_function_finetuning.html"
           ]
         },
         {
           "group":"Validation",
           "pages":[
-            "docs/4_tutorials/cross_validation.html",
-            "docs/4_tutorials/historical_forecast.html"
+            "docs/4_tutorials/8_cross_validation.html",
+            "docs/4_tutorials/9_historical_forecast.html"
           ]
         },
         {
           "group":"Uncertainty quantification",
           "pages":[
-            "docs/4_tutorials/uncertainty_quantification_with_quantile_forecasts.html",
-            "docs/4_tutorials/uncertainty_quantification_with_prediction_intervals.html"
+            "docs/4_tutorials/10_uncertainty_quantification_with_quantile_forecasts.html",
+            "docs/4_tutorials/11_uncertainty_quantification_with_prediction_intervals.html"
           ]
         },
         {
           "group":"Special Topics",
           "pages":[
-            "docs/4_tutorials/irregular_timestamps.html",
-            "docs/4_tutorials/bounded_forecasts.html",
-            "docs/4_tutorials/hierarchical_forecasting.html"
+            "docs/4_tutorials/12_irregular_timestamps.html",
+            "docs/4_tutorials/13_bounded_forecasts.html",
+            "docs/4_tutorials/14_hierarchical_forecasting.html"
           ]
         },
         {
           "group":"Computing at scale",
           "pages":[
-            "docs/4_tutorials/computing_at_scale.html",
-            "docs/4_tutorials/computing_at_scale_spark_distributed.html",
-            "docs/4_tutorials/computing_at_scale_dask_distributed.html",
-            "docs/4_tutorials/computing_at_scale_ray_distributed.html"            
+            "docs/4_tutorials/15_computing_at_scale.html",
+            "docs/4_tutorials/16_computing_at_scale_spark_distributed.html",
+            "docs/4_tutorials/17_computing_at_scale_dask_distributed.html",
+            "docs/4_tutorials/18_computing_at_scale_ray_distributed.html"            
           ]
         }        
       ]
     },
     {
       "group": "Use cases",
       "pages": [
-        "docs/5_use_cases/forecasting_web_traffic_with_timegpt.html",
-        "docs/5_use_cases/bitcoin_price_prediction.html"
+        "docs/5_use_cases/1_forecasting_web_traffic.html",
+        "docs/5_use_cases/2_bitcoin_price_prediction.html"
     ]
     },
     {