ipex-llm/docs/readthedocs/source/_toc.yml
Junwei Deng a6f96521af Chronos: AIOps User Guide (#7960)
* add aiops doc

* add image

* fix typo
2023-03-31 10:15:00 +08:00

362 lines
17 KiB
YAML

root: index
subtrees:
- entries:
- file: doc/UserGuide/index
title: 'User guide'
subtrees:
- entries:
- file: doc/UserGuide/python
- file: doc/UserGuide/scala
- file: doc/UserGuide/win
- file: doc/UserGuide/docker
- file: doc/UserGuide/colab
- file: doc/UserGuide/hadoop
- file: doc/UserGuide/k8s
- file: doc/UserGuide/databricks
- entries:
- file: doc/Application/powered-by
title: "Powered by"
- entries:
- file: doc/Orca/index
title: "Orca"
subtrees:
- entries:
- file: doc/Orca/Overview/orca
title: "Orca in 5 minutes"
- file: doc/Orca/Overview/install
title: "Installation"
- file: doc/Orca/Overview/index
title: "Key Features"
subtrees:
- entries:
- file: doc/Orca/Overview/orca-context
- file: doc/Orca/Overview/data-parallel-processing
- file: doc/Orca/Overview/distributed-training-inference
- file: doc/Orca/Overview/distributed-tuning
- file: doc/Orca/Overview/ray
- file: doc/Orca/Howto/index
title: "How-to Guides"
subtrees:
- entries:
- file: doc/Orca/Howto/tf2keras-quickstart
- file: doc/Orca/Howto/pytorch-quickstart
- file: doc/Orca/Howto/ray-quickstart
- file: doc/Orca/Howto/spark-dataframe
- file: doc/Orca/Howto/xshards-pandas
- file: doc/Orca/Howto/autoestimator-pytorch-quickstart
- file: doc/Orca/Howto/autoxgboost-quickstart
- file: doc/Orca/Howto/tf1-quickstart
- file: doc/Orca/Howto/tf1keras-quickstart
- file: doc/Orca/Tutorial/index
title: "Tutorials"
subtrees:
- entries:
- file: doc/Orca/Tutorial/yarn
- file: doc/Orca/Tutorial/k8s
- file: doc/Orca/Overview/known_issues
title: "Tips and Known Issues"
- file: doc/PythonAPI/Orca/index
title: "API Reference"
- entries:
- file: doc/Nano/index
title: "Nano"
subtrees:
- entries:
- file: doc/Nano/Overview/nano
title: "Nano in 5 minutes"
- file: doc/Nano/Overview/install
title: "Installation"
- file: doc/Nano/Overview/index
title: "Key Features"
subtrees:
- entries:
- file: doc/Nano/Overview/pytorch_train
- file: doc/Nano/Overview/pytorch_inference
- file: doc/Nano/Overview/pytorch_cuda_patch
- file: doc/Nano/Overview/tensorflow_train
- file: doc/Nano/Overview/tensorflow_inference
- file: doc/Nano/Overview/hpo
- file: doc/Nano/QuickStart/index
title: "Tutorials"
subtrees:
- entries:
- file: doc/Nano/QuickStart/pytorch_train_quickstart
- file: doc/Nano/QuickStart/pytorch_nano
- file: doc/Nano/QuickStart/pytorch_onnxruntime
- file: doc/Nano/QuickStart/pytorch_openvino
- file: doc/Nano/QuickStart/pytorch_quantization_inc_onnx
- file: doc/Nano/QuickStart/pytorch_quantization_inc
- file: doc/Nano/QuickStart/pytorch_quantization_openvino
- file: doc/Nano/QuickStart/tensorflow_train_quickstart
- file: doc/Nano/QuickStart/tensorflow_embedding
- file: doc/Nano/QuickStart/tensorflow_quantization_quickstart
- file: doc/Nano/Howto/index
title: "How-to Guides"
subtrees:
- entries:
- file: doc/Nano/Howto/Preprocessing/index
subtrees:
- entries:
- file: doc/Nano/Howto/Preprocessing/PyTorch/index
title: "PyTorch"
subtrees:
- entries:
- file: doc/Nano/Howto/Preprocessing/PyTorch/accelerate_pytorch_cv_data_pipeline
- file: doc/Nano/Howto/Training/index
subtrees:
- entries:
- file: doc/Nano/Howto/Training/PyTorchLightning/index
title: "PyTorch Lightning"
subtrees:
- entries:
- file: doc/Nano/Howto/Training/PyTorchLightning/accelerate_pytorch_lightning_training_ipex
- file: doc/Nano/Howto/Training/PyTorchLightning/accelerate_pytorch_lightning_training_multi_instance
- file: doc/Nano/Howto/Training/PyTorchLightning/pytorch_lightning_training_channels_last
- file: doc/Nano/Howto/Training/PyTorchLightning/pytorch_lightning_training_bf16
- file: doc/Nano/Howto/Training/PyTorch/index
title: "PyTorch"
subtrees:
- entries:
- file: doc/Nano/Howto/Training/PyTorch/convert_pytorch_training_torchnano
- file: doc/Nano/Howto/Training/PyTorch/use_nano_decorator_pytorch_training
- file: doc/Nano/Howto/Training/PyTorch/accelerate_pytorch_training_ipex
- file: doc/Nano/Howto/Training/PyTorch/accelerate_pytorch_training_multi_instance
- file: doc/Nano/Howto/Training/PyTorch/pytorch_training_channels_last
- file: doc/Nano/Howto/Training/PyTorch/accelerate_pytorch_training_bf16
- file: doc/Nano/Howto/Training/TensorFlow/index
title: "TensorFlow"
subtrees:
- entries:
- file: doc/Nano/Howto/Training/TensorFlow/accelerate_tensorflow_training_multi_instance
- file: doc/Nano/Howto/Training/TensorFlow/tensorflow_training_embedding_sparseadam
- file: doc/Nano/Howto/Training/TensorFlow/tensorflow_training_bf16
- file: doc/Nano/Howto/Training/General/index
title: "General"
subtrees:
- entries:
- file: doc/Nano/Howto/Training/General/choose_num_processes_training
- file: doc/Nano/Howto/Inference/index
subtrees:
- entries:
- file: doc/Nano/Howto/Inference/OpenVINO/index
title: "OpenVINO"
subtrees:
- entries:
- file: doc/Nano/Howto/Inference/OpenVINO/openvino_inference
- file: doc/Nano/Howto/Inference/OpenVINO/openvino_inference_async
- file: doc/Nano/Howto/Inference/OpenVINO/accelerate_inference_openvino_gpu
- file: doc/Nano/Howto/Inference/PyTorch/index
title: "PyTorch"
subtrees:
- entries:
- file: doc/Nano/Howto/Inference/PyTorch/inference_optimizer_optimize
- file: doc/Nano/Howto/Inference/PyTorch/accelerate_pytorch_inference_onnx
- file: doc/Nano/Howto/Inference/PyTorch/accelerate_pytorch_inference_openvino
- file: doc/Nano/Howto/Inference/PyTorch/accelerate_pytorch_inference_jit_ipex
- file: doc/Nano/Howto/Inference/PyTorch/quantize_pytorch_inference_inc
- file: doc/Nano/Howto/Inference/PyTorch/quantize_pytorch_inference_pot
- file: doc/Nano/Howto/Inference/PyTorch/pytorch_context_manager
- file: doc/Nano/Howto/Inference/PyTorch/pytorch_save_and_load_ipex
- file: doc/Nano/Howto/Inference/PyTorch/pytorch_save_and_load_jit
- file: doc/Nano/Howto/Inference/PyTorch/pytorch_save_and_load_onnx
- file: doc/Nano/Howto/Inference/PyTorch/pytorch_save_and_load_openvino
- file: doc/Nano/Howto/Inference/PyTorch/multi_instance_pytorch_inference
- file: doc/Nano/Howto/Inference/TensorFlow/index
title: "TensorFlow"
subtrees:
- entries:
- file: doc/Nano/Howto/Inference/TensorFlow/accelerate_tensorflow_inference_onnx
- file: doc/Nano/Howto/Inference/TensorFlow/accelerate_tensorflow_inference_openvino
- file: doc/Nano/Howto/Inference/TensorFlow/tensorflow_inference_bf16
- file: doc/Nano/Howto/Inference/TensorFlow/tensorflow_save_and_load_onnx
- file: doc/Nano/Howto/Inference/TensorFlow/tensorflow_save_and_load_openvino
- file: doc/Nano/Howto/Install/index
subtrees:
- entries:
- file: doc/Nano/Howto/Install/install_in_colab
- file: doc/Nano/Howto/Install/windows_guide
- file: doc/Nano/Overview/known_issues
title: "Tips and Known Issues"
- file: doc/Nano/Overview/troubshooting
title: "Troubleshooting Guide"
- file: doc/Nano/Overview/support
title: "OS Support"
- file: doc/PythonAPI/Nano/index
title: "API Reference"
- entries:
- file: doc/DLlib/index
title: "DLlib"
subtrees:
- entries:
- file: doc/DLlib/Overview/dllib
title: "DLLib in 5 minutes"
- file: doc/DLlib/Overview/install
title: "Installation"
- file: doc/DLlib/Overview/index
title: "Key Features"
subtrees:
- entries:
- file: doc/DLlib/Overview/keras-api
- file: doc/DLlib/Overview/nnframes
- file: doc/DLlib/Overview/visualization
title: "Visualization"
- file: doc/DLlib/QuickStart/index
title: "Tutorials"
subtrees:
- entries:
- file: doc/DLlib/QuickStart/python-getting-started
title: "Python Quick Start"
- file: doc/DLlib/QuickStart/scala-getting-started
title: "Scala Quick Start"
- file: doc/PythonAPI/DLlib/index
title: "API Reference"
- entries:
- file: doc/Chronos/index
title: "Chronos"
subtrees:
- entries:
- file: doc/Chronos/Overview/quick-tour
title: "Chronos in 5 minutes"
- file: doc/Chronos/Overview/install
title: "Installation"
- file: doc/Chronos/Overview/deep_dive
title: "Key Features"
subtrees:
- entries:
- file: doc/Chronos/Overview/data_processing_feature_engineering
- file: doc/Chronos/Overview/forecasting
- file: doc/Chronos/Overview/anomaly_detection
- file: doc/Chronos/Overview/simulation
- file: doc/Chronos/Overview/aiops
- file: doc/Chronos/Overview/speed_up
- file: doc/Chronos/Overview/useful_functionalities
- file: doc/Chronos/Howto/index
title: "How-to Guides"
subtrees:
- entries:
- file: doc/Chronos/Howto/windows_guide
- file: doc/Chronos/Howto/docker_guide_single_node
- file: doc/Chronos/Howto/how_to_use_benchmark_tool
- file: doc/Chronos/Howto/how_to_create_forecaster
- file: doc/Chronos/Howto/how_to_train_forecaster_on_one_node
- file: doc/Chronos/Howto/how_to_save_and_load_forecaster
- file: doc/Chronos/Howto/how_to_tune_forecaster_model
- file: doc/Chronos/Howto/how_to_speedup_inference_of_forecaster_through_ONNXRuntime
- file: doc/Chronos/Howto/how_to_speedup_inference_of_forecaster_through_OpenVINO
- file: doc/Chronos/Howto/how_to_evaluate_a_forecaster
- file: doc/Chronos/Howto/how_to_use_forecaster_to_predict_future_data
- file: doc/Chronos/Howto/how_to_optimize_a_forecaster
- file: doc/Chronos/Howto/how_to_generate_confidence_interval_for_prediction
- file: doc/Chronos/Howto/how_to_export_onnx_files
- file: doc/Chronos/Howto/how_to_export_openvino_files
- file: doc/Chronos/Howto/how_to_export_torchscript_files
- file: doc/Chronos/Howto/how_to_preprocess_my_data
- file: doc/Chronos/Howto/how_to_process_data_in_production_environment
- file: doc/Chronos/Howto/how_to_choose_forecasting_alg
- file: doc/Chronos/Howto/how_to_export_data_processing_pipeline_to_torchscript
- file: doc/Chronos/QuickStart/index
title: "Tutorials"
subtrees:
- entries:
- file: doc/Chronos/QuickStart/chronos-tsdataset-forecaster-quickstart
- file: doc/Chronos/QuickStart/chronos-autotsest-quickstart
- file: doc/Chronos/QuickStart/chronos-anomaly-detector
- file: doc/Chronos/Overview/chronos_known_issue
title: "Tips and Known Issues"
- file: doc/PythonAPI/Chronos/index
title: "API Reference"
- entries:
- file: doc/Friesian/index
title: "Friesian"
subtrees:
- entries:
- file: doc/Friesian/intro
title: "Introduction"
- file: doc/Friesian/serving
title: "Serving"
- file: doc/Friesian/examples
title: "Use Cases"
- file: doc/PythonAPI/Friesian/index
title: "API Reference"
- entries:
- file: doc/PPML/index
title: "PPML"
subtrees:
- entries:
- file: doc/PPML/Overview/intro
title: "PPML Introduction"
- file: doc/PPML/Overview/install
title: 'Installation'
- file: doc/PPML/Overview/examples
title: "Tutorials"
subtrees:
- entries:
- file: doc/PPML/Overview/quicktour
- file: doc/PPML/QuickStart/end-to-end
- file: doc/PPML/Overview/devguide
- file: doc/PPML/Overview/azure_ppml
- file: doc/PPML/Overview/ali_ecs_occlum_cn
- file: doc/PPML/Overview/misc
title: "Advanced Topics"
subtrees:
- entries:
- file: doc/PPML/Overview/ppml
- file: doc/PPML/Overview/attestation_basic
- file: doc/PPML/Overview/trusted_big_data_analytics_and_ml
- file: doc/PPML/Overview/trusted_fl
- file: doc/PPML/QuickStart/secure_your_services
- file: doc/PPML/QuickStart/deploy_ppml_in_production
- file: doc/PPML/QuickStart/install_sgx_driver
- file: doc/PPML/QuickStart/deploy_intel_sgx_device_plugin_for_kubernetes
- file: doc/PPML/QuickStart/trusted-serving-on-k8s-guide
- file: doc/PPML/QuickStart/tpc-h_with_sparksql_on_k8s
- file: doc/PPML/QuickStart/tpc-ds_with_sparksql_on_k8s
- file: doc/PPML/Overview/azure_ppml_occlum
- entries:
- file: doc/UserGuide/contributor
title: "Contributor guide"
subtrees:
- entries:
- file: doc/UserGuide/develop
- file: doc/UserGuide/documentation
- entries:
- file: doc/Serving/index
title: "Cluster serving"
subtrees:
- entries:
- file: doc/Serving/Overview/serving.md
title: "User Guide"
- file: doc/Serving/QuickStart/serving-quickstart
title: "Serving in 5 miniutes"
- file: doc/Serving/ProgrammingGuide/serving-installation
- file: doc/Serving/ProgrammingGuide/serving-start
- file: doc/Serving/ProgrammingGuide/serving-inference
- file: doc/Serving/Example/example
title: "Examples"
- file: doc/Serving/FAQ/faq
- file: doc/Serving/FAQ/contribute-guide
- entries:
- file: doc/Application/presentations
title: "Presentations"
- entries:
- file: doc/Application/blogs