Chronos: Refactor document structure (#3839)
* add strcture change * add change in index * add change to index.rst * revice the document * add icons * revise on the pages * add readme update * remove ood information * change title
This commit is contained in:
		
							parent
							
								
									12dca51115
								
							
						
					
					
						commit
						625a8f89fe
					
				
					 6 changed files with 42 additions and 11 deletions
				
			
		
							
								
								
									
										18
									
								
								docs/readthedocs/source/doc/Chronos/Overview/deep_dive.rst
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										18
									
								
								docs/readthedocs/source/doc/Chronos/Overview/deep_dive.rst
									
									
									
									
									
										Normal file
									
								
							| 
						 | 
				
			
			@ -0,0 +1,18 @@
 | 
			
		|||
Chronos Deep Dive
 | 
			
		||||
=========
 | 
			
		||||
 | 
			
		||||
* `Time Series Processing and Feature Engineering <data_processing_feature_engineering.md>`__ introduces how to load a built-in/customized dataset and carry out transformation and feature engineering on it.
 | 
			
		||||
* `Time Series Forecasting <forecasting.md>`__ introduces how to build a time series forecasting application.
 | 
			
		||||
* `Time Series Anomaly Detection <anomaly_detection.md>`__ introduces how to build a anomaly detection application.
 | 
			
		||||
* `Generate Synthetic Sequential Data <simulation.md>`__ introduces how to build a series data generation application.
 | 
			
		||||
* `Useful Functionalities <useful_functionalities.md>`__ 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
 | 
			
		||||
| 
						 | 
				
			
			@ -1,4 +1,4 @@
 | 
			
		|||
# Anomaly Detector Quickstart
 | 
			
		||||
# Detect Anomaly Point in Real Time Traffic Data
 | 
			
		||||
 | 
			
		||||
---
 | 
			
		||||
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -1,4 +1,4 @@
 | 
			
		|||
# AutoTSEstimator Quickstart
 | 
			
		||||
# Tune a Forecasting Task Automatically
 | 
			
		||||
 | 
			
		||||
---
 | 
			
		||||
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -1,4 +1,4 @@
 | 
			
		|||
# TSDataset and Forecaster Quickstarts
 | 
			
		||||
# Predict Number of Taxi Passengers with Chronos Forecaster
 | 
			
		||||
 | 
			
		||||
---
 | 
			
		||||
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
							
								
								
									
										19
									
								
								docs/readthedocs/source/doc/Chronos/QuickStart/index.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										19
									
								
								docs/readthedocs/source/doc/Chronos/QuickStart/index.md
									
									
									
									
									
										Normal file
									
								
							| 
						 | 
				
			
			@ -0,0 +1,19 @@
 | 
			
		|||
# Chronos Tutorial
 | 
			
		||||
 | 
			
		||||
- [**Predict Number of Taxi Passengers with Chronos Forecaster**](./chronos-tsdataset-forecaster-quickstart.html)
 | 
			
		||||
 | 
			
		||||
    [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)  [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)
 | 
			
		||||
 | 
			
		||||
    [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)  [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)
 | 
			
		||||
 | 
			
		||||
    [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)  [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.
 | 
			
		||||
| 
						 | 
				
			
			@ -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
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
		Loading…
	
		Reference in a new issue