ipex-llm/docs/readthedocs/source/_toc.yml
Yuwen Hu 30dd0bd6c2 [Nano] Nano How-to Guides: Format & PyTorch Inference (#5480)
* Create doc tree index for Nano How-to Guides

* Add How to guide for PyTorch Inference using ONNXRuntime

* Add How to guide for PyTorch Inference using OpenVINO

* Update How to guide for PyTorch Inference using OpenVINO/ONNXRuntime

* Change current notebook to md and revise contents to be more concentrated

* Add How-to Guide: Install BigDL-Nano in Google Colab (need further update)

* Revise words in How-to Guide for PyTorch Inference using OpenVINO/ONNXRuntime

* Add How-To Guide: Quantize PyTorch Model for Inference using Intel Neural Compressor

* Add How-To Guide: Quantize PyTorch Model for Inference using Post-training Quantization Tools

* Add API doc links and small revision

* Test: syncronization through marks in py files

* Test: syncronization through notebook with cells hidden from rendering in doc

* Remove test commits for runnable example <-> guides synchronization

* Enable rendering notebook from location out of sphinx source root

* Update guide "How to accelerate a PyTorch inference pipeline through OpenVINO" to notebook under python folder

* Update guide "How to quantize your PyTorch model for inference using Intel Neural Compressor" to notebook under python folder

* Fix bug that markdown will be ignored inside html tags for nbconvert, and notebook revise

* Update guide 'How to quantize your PyTorch model for inference using Post-training Optimization Tools' to notebook under python folder

* Small updates to index and current guides

* Revision based on Junwei's comments

* Update how-to guides: How to install BigDL-Nano in Google Colab, and update index page

* Small typo fix
2022-09-02 10:17:06 +08:00

107 lines
3.7 KiB
YAML

root: index
subtrees:
- caption: Quick Start
entries:
- file: doc/Orca/QuickStart/orca-tf-quickstart
- file: doc/Orca/QuickStart/orca-keras-quickstart
- file: doc/Orca/QuickStart/orca-tf2keras-quickstart
- file: doc/Orca/QuickStart/orca-pytorch-quickstart
- file: doc/Ray/QuickStart/ray-quickstart
- caption: User Guide
entries:
- file: doc/UserGuide/python
- file: doc/UserGuide/scala
- file: doc/UserGuide/colab
- file: doc/UserGuide/docker
- file: doc/UserGuide/hadoop
- file: doc/UserGuide/k8s
- file: doc/UserGuide/databricks
- file: doc/UserGuide/develop
- file: doc/UserGuide/known_issues
- caption: Nano
entries:
- file: doc/Nano/Overview/nano
- file: doc/Nano/Overview/windows_guide
- file: doc/Nano/QuickStart/pytorch_train
- file: doc/Nano/QuickStart/pytorch_inference
- file: doc/Nano/QuickStart/tensorflow_train
- file: doc/Nano/QuickStart/tensorflow_inference
- file: doc/Nano/QuickStart/hpo
- file: doc/Nano/QuickStart/index
- file: doc/Nano/Howto/index
- file: doc/Nano/Overview/known_issues
- caption: DLlib
entries:
- file: doc/DLlib/Overview/dllib
- file: doc/DLlib/Overview/keras-api
- file: doc/DLlib/Overview/nnframes
- caption: Orca
entries:
- file: doc/Orca/Overview/orca
title: "Orca User Guide"
- 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/Ray/Overview/ray
- file: doc/Orca/Overview/known_issues
- caption: Chronos
entries:
- file: doc/Chronos/Overview/chronos
- file: doc/Chronos/Overview/windows_guide
- file: doc/Chronos/Overview/quick-tour
- file: doc/Chronos/Overview/deep_dive
- file: doc/Chronos/Howto/index
- file: doc/Chronos/QuickStart/index
- file: doc/Chronos/Overview/chronos_known_issue
- caption: PPML
entries:
- file: doc/PPML/Overview/ppml
- 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/build_kernel_with_sgx
- 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
- caption: Serving
entries:
- file: doc/Serving/Overview/serving.md
- file: doc/Serving/QuickStart/serving-quickstart
- file: doc/Serving/ProgrammingGuide/serving-installation
- file: doc/Serving/ProgrammingGuide/serving-start
- file: doc/Serving/ProgrammingGuide/serving-inference
- file: doc/Serving/Example/example
- file: doc/Serving/FAQ/faq
- file: doc/Serving/FAQ/contribute-guide
- caption: Common Use Case
entries:
- file: doc/Orca/QuickStart/orca-pytorch-distributed-quickstart
- file: doc/UseCase/spark-dataframe
- file: doc/UseCase/xshards-pandas
- file: doc/Orca/QuickStart/orca-autoestimator-pytorch-quickstart
- file: doc/Orca/QuickStart/orca-autoxgboost-quickstart
- caption: Python API
entries:
- file: doc/PythonAPI/Orca/orca
- file: doc/PythonAPI/Friesian/feature
- file: doc/PythonAPI/Chronos/index
- file: doc/PythonAPI/Nano/index
- caption: Real-World Application
entries:
- file: doc/Application/presentations
- file: doc/Application/blogs
- file: doc/Application/powered-by