diff --git a/docs/readthedocs/source/doc/Chronos/Overview/deep_dive.rst b/docs/readthedocs/source/doc/Chronos/Overview/deep_dive.rst new file mode 100644 index 00000000..b736fa64 --- /dev/null +++ b/docs/readthedocs/source/doc/Chronos/Overview/deep_dive.rst @@ -0,0 +1,18 @@ +Chronos Deep Dive +========= + +* `Time Series Processing and Feature Engineering `__ introduces how to load a built-in/customized dataset and carry out transformation and feature engineering on it. +* `Time Series Forecasting `__ introduces how to build a time series forecasting application. +* `Time Series Anomaly Detection `__ introduces how to build a anomaly detection application. +* `Generate Synthetic Sequential Data `__ introduces how to build a series data generation application. +* `Useful Functionalities `__ introduces some functionalities provided by Chronos that can help you improve accuracy/performance or scale the application to a larger data. + +.. toctree:: + :maxdepth: 1 + :hidden: + + data_processing_feature_engineering.md + forecasting.md + anomaly_detection.md + simulation.md + useful_functionalities.md diff --git a/docs/readthedocs/source/doc/Chronos/QuickStart/chronos-anomaly-detector.md b/docs/readthedocs/source/doc/Chronos/QuickStart/chronos-anomaly-detector.md index d28c39a4..0a0b0190 100644 --- a/docs/readthedocs/source/doc/Chronos/QuickStart/chronos-anomaly-detector.md +++ b/docs/readthedocs/source/doc/Chronos/QuickStart/chronos-anomaly-detector.md @@ -1,4 +1,4 @@ -# Anomaly Detector Quickstart +# Detect Anomaly Point in Real Time Traffic Data --- diff --git a/docs/readthedocs/source/doc/Chronos/QuickStart/chronos-autotsest-quickstart.md b/docs/readthedocs/source/doc/Chronos/QuickStart/chronos-autotsest-quickstart.md index a98acab3..0486bf22 100644 --- a/docs/readthedocs/source/doc/Chronos/QuickStart/chronos-autotsest-quickstart.md +++ b/docs/readthedocs/source/doc/Chronos/QuickStart/chronos-autotsest-quickstart.md @@ -1,4 +1,4 @@ -# AutoTSEstimator Quickstart +# Tune a Forecasting Task Automatically --- diff --git a/docs/readthedocs/source/doc/Chronos/QuickStart/chronos-tsdataset-forecaster-quickstart.md b/docs/readthedocs/source/doc/Chronos/QuickStart/chronos-tsdataset-forecaster-quickstart.md index f0a59d88..de2d6c79 100644 --- a/docs/readthedocs/source/doc/Chronos/QuickStart/chronos-tsdataset-forecaster-quickstart.md +++ b/docs/readthedocs/source/doc/Chronos/QuickStart/chronos-tsdataset-forecaster-quickstart.md @@ -1,4 +1,4 @@ -# TSDataset and Forecaster Quickstarts +# Predict Number of Taxi Passengers with Chronos Forecaster --- diff --git a/docs/readthedocs/source/doc/Chronos/QuickStart/index.md b/docs/readthedocs/source/doc/Chronos/QuickStart/index.md new file mode 100644 index 00000000..d493cb04 --- /dev/null +++ b/docs/readthedocs/source/doc/Chronos/QuickStart/index.md @@ -0,0 +1,19 @@ +# Chronos Tutorial + +- [**Predict Number of Taxi Passengers with Chronos Forecaster**](./chronos-tsdataset-forecaster-quickstart.html) + + ![](../../../../image/colab_logo_32px.png)[Run in Google Colab](https://colab.research.google.com/github/intel-analytics/BigDL/blob/branch-2.0/python/chronos/colab-notebook/chronos_nyc_taxi_tsdataset_forecaster.ipynb)  ![](../../../../image/GitHub-Mark-32px.png)[View source on GitHub](https://github.com/intel-analytics/BigDL/blob/branch-2.0/python/chronos/colab-notebook/chronos_nyc_taxi_tsdataset_forecaster.ipynb) + + In this guide we will demonstrate how to use _Chronos TSDataset_ and _Chronos Forecaster_ for time series processing and predict number of taxi passengers. + +- [**Tune a Forecasting Task Automatically**](./chronos-autotsest-quickstart.html) + + ![](../../../../image/colab_logo_32px.png)[Run in Google Colab](https://colab.research.google.com/github/intel-analytics/BigDL/blob/branch-2.0/python/chronos/colab-notebook/chronos_autots_nyc_taxi.ipynb)  ![](../../../../image/GitHub-Mark-32px.png)[View source on GitHub](https://github.com/intel-analytics/BigDL/blob/branch-2.0/python/chronos/colab-notebook/chronos_autots_nyc_taxi.ipynb) + + In this guide we will demonstrate how to use _Chronos AutoTSEstimator_ and _Chronos TSPipeline_ to auto tune a time seires forecasting task and handle the whole model development process easily. + +- [**Detect Anomaly Point in Real Time Traffic Data**](./chronos-anomaly-detector.html) + + ![](../../../../image/colab_logo_32px.png)[Run in Google Colab](https://colab.research.google.com/github/intel-analytics/BigDL/blob/branch-2.0/python/chronos/colab-notebook/chronos_minn_traffic_anomaly_detector.ipynb)  ![](../../../../image/GitHub-Mark-32px.png)[View source on GitHub](https://github.com/intel-analytics/BigDL/blob/branch-2.0/python/chronos/colab-notebook/chronos_minn_traffic_anomaly_detector.ipynb) + + In this guide we will demonstrate how to use _Chronos Anomaly Detector_ for real time traffic data from the Twin Cities Metro area in Minnesota anomaly detection. \ No newline at end of file diff --git a/docs/readthedocs/source/index.rst b/docs/readthedocs/source/index.rst index a69e8230..1e4549f4 100644 --- a/docs/readthedocs/source/index.rst +++ b/docs/readthedocs/source/index.rst @@ -65,14 +65,8 @@ BigDL Documentation :caption: Chronos Overview doc/Chronos/Overview/chronos.md - doc/Chronos/Overview/data_processing_feature_engineering.md - doc/Chronos/Overview/forecasting.md - doc/Chronos/Overview/anomaly_detection.md - doc/Chronos/Overview/simulation.md - doc/Chronos/Overview/useful_functionalities.md - doc/Chronos/QuickStart/chronos-autotsest-quickstart.md - doc/Chronos/QuickStart/chronos-tsdataset-forecaster-quickstart.md - doc/Chronos/QuickStart/chronos-anomaly-detector.md + doc/Chronos/Overview/deep_dive.rst + doc/Chronos/QuickStart/index.md .. toctree:: :maxdepth: 1