ipex-llm/docs/readthedocs/source/_toc.yml
Shengsheng Huang f2e4c40cee change the readthedocs theme and reorg the sections (#6056)
* refactor toc

* refactor toc

* Change to pydata-sphinx-theme and update packages requirement list for ReadtheDocs

* Remove customized css for old theme

* Add index page to each top bar section and limit dropdown maximum to be 4

* Use js to change 'More' to 'Libraries'

* Add custom.css to conf.py for further css changes

* Add BigDL logo and search bar

* refactor toc

* refactor toc and add overview

* refactor toc and add overview

* refactor toc and add overview

* refactor get started

* add paper and video section

* add videos

* add grid columns in landing page

* add document roadmap to index

* reapply search bar and github icon commit

* reorg orca and chronos sections

* Test: weaken ads by js

* update: change left attrbute

* update: add comments

* update: change opacity to 0.7

* Remove useless theme template override for old theme

* Add sidebar releases component in the home page

* Remove sidebar search and restore top nav search button

* Add BigDL handouts

* Add back to homepage button to pages except from the home page

* Update releases contents & styles in left sidebar

* Add version badge to the top bar

* Test: weaken ads by js

* update: add comments

* remove landing page contents

* rfix chronos install

* refactor install

* refactor chronos section titles

* refactor nano index

* change chronos landing

* revise chronos landing page

* add document navigator to nano landing page

* revise install landing page

* Improve css of versions in sidebar

* Make handouts image pointing to a page in new tab

* add win guide to install

* add dliib installation

* revise title bar

* rename index files

* add index page for user guide

* add dllib and orca API

* update user guide landing page

* refactor side bar

* Remove extra style configuration of card components & make different card usage consistent

* Remove extra styles for Nano how-to guides

* Remove extra styles for Chronos how-to guides

* Remove dark mode for now

* Update index page description

* Add decision tree for choosing BigDL libraries in index page

* add dllib models api, revise core layers formats

* Change primary & info color in light mode

* Restyle card components

* Restructure Chronos landing page

* Update card style

* Update BigDL library selection decision tree

* Fix failed Chronos tutorials filter

* refactor PPML documents

* refactor and add friesian documents

* add friesian arch diagram

* update landing pages and fill key features guide index page

* Restyle link card component

* Style video frames in PPML sections

* Adjust Nano landing page

* put api docs to the last in index for convinience

* Make badge horizontal padding smaller & small changes

* Change the second letter of all header titles to be small capitalizd

* Small changes on Chronos index page

* Revise decision tree to make it smaller

* Update: try to change the position of ads.

* Bugfix: deleted nonexist file config

* Update: update ad JS/CSS/config

* Update: change ad.

* Update: delete my template and change files.

* Update: change chronos installation table color.

* Update: change table font color to --pst-color-primary-text

* Remove old contents in landing page sidebar

* Restyle badge for usage in card footer again

* Add quicklinks template on landing page sidebar

* add quick links

* Add scala logo

* move tf, pytorch out of the link

* change orca key features cards

* fix typo

* fix a mistake in wording

* Restyle badge for card footer

* Update decision tree

* Remove useless html templates

* add more api docs and update tutorials in dllib

* update chronos install using new style

* merge changes in nano doc from master

* fix quickstart links in sidebar quicklinks

* Make tables responsive

* Fix overflow in api doc

* Fix list indents problems in [User guide] section

* Further fixes to nested bullets contents in [User Guide] section

* Fix strange title in Nano 5-min doc

* Fix list indent problems in [DLlib] section

* Fix misnumbered list problems and other small fixes for [Chronos] section

* Fix list indent problems and other small fixes for [Friesian] section

* Fix list indent problem and other small fixes for [PPML] section

* Fix list indent problem for developer guide

* Fix list indent problem for [Cluster Serving] section

* fix dllib links

* Fix wrong relative link in section landing page

Co-authored-by: Yuwen Hu <yuwen.hu@intel.com>
Co-authored-by: Juntao Luo <1072087358@qq.com>
2022-10-18 15:35:31 +08:00

224 lines
8 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 miniutes"
- 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/QuickStart/index
title: "Tutorials"
subtrees:
- entries:
- file: doc/UseCase/spark-dataframe
- file: doc/UseCase/xshards-pandas
- file: doc/Orca/QuickStart/ray-quickstart
- file: doc/Orca/QuickStart/orca-pytorch-distributed-quickstart
- file: doc/Orca/QuickStart/orca-autoestimator-pytorch-quickstart
- file: doc/Orca/QuickStart/orca-autoxgboost-quickstart
- 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/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_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"
- file: doc/Nano/Overview/known_issues
title: "Tips and Known Issues"
- 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"
- file: doc/Chronos/Howto/index
title: "How-to Guides"
- 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/userguide
title: 'User Guide'
- 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/misc
title: "Advanced Topics"
subtrees:
- 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
- entries:
- file: doc/UserGuide/develop
title: "Developer guide"
- 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