Commit graph

15 commits

Author SHA1 Message Date
Yuwen Hu
0407ebf5c3 [Doc] Remove manually-added bold styles for titles (#6215)
* Remove manually-added bold style for titles in [User guide] section

* Fix failed relative links in windows user guide

* Remove manually-added bold style for titles in [Orca] section

* Fix failed relative links & title bold fix in Nano 5 min

* Remove manually-added bold style for titles in [Nano] section

* Remove manually-added bold style for titles in [DLlib] section

* Remove manually-added bold style for titles in [Chronos] section

* Remove manually-added bold style for titles in Developer guide

* Remove manually-added bold title style for all other not-included md files in docs/readthedocs/source/doc folder

* Fix based on comments
2022-10-20 13:48:22 +08:00
Yishuo Wang
7b28b3fd20 Nano: Rename strategy parameter of TorchNano to distributed_backend (#6126) 2022-10-20 09:16:55 +08:00
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
Shengsheng Huang
fbd5a57f93 add windows user guide (#5950)
* add windows user guide

* modifiy win user guides

* Add jupyter setup guide and known issues

* Add tips for yolov3 example

* update win guide

* update win guide

* update win guide reference

* update win guide reference

* update win guide reference

* format fix

* revise nano and chronos windows guide

* fix windows guide reference in nano install

Co-authored-by: aixideng <aixi.deng@intel.com>
2022-10-11 13:14:40 +08:00
Yang Wang
0d696fcf92 Add tensorflow known issue for inter op parallelism cannot be modified (#5923)
* Add tensorflow known issue for inter op parallelism cannot be modified

* try clear session

* remove clear session
2022-09-27 10:45:43 -07:00
Yishuo Wang
62b8aa8703 fix nano UT (#5650) 2022-09-06 17:09:31 +08:00
Yuwen Hu
7ef605b58f [Nano] Correct typos in ReadtheDocs (#5250)
* Correct typos for Nano User Guide page

* Correct typos for BigDL-Nano PyTorch Training Overview page

* Correct typos for BigDL-Nano PyTorch Inference Overview page

* Correct typos for BigDL-Nano PyTorch ONNXRuntime Acceleration Quickstart page

* Correct typos for Windows User Guide page

* Correct typos for BigDL-Nano TensorFlow Training Overview page

* Correct typos for BigDL-Nano TensorFlow Inference Overview page

* Small fix based on Shengsheng's comments

* Fix based on Wang, Yang's comments
2022-08-03 10:37:08 +08:00
Yishuo Wang
0f78a568c7 add tutorial, notebook and API doc for LightningLite (#5114)
* add tutorial, notebook and API doc for LightningLite
* increase the timeout when running tutorial notebook
* change docs and tutorial to use new API
2022-08-02 09:15:50 +08:00
Yang Wang
55fa3e13e6 Add Nano Known issues and some notebook link (#4667)
* Add Nano Known issues and some notebook link

* fix typo
2022-05-25 10:26:46 +08:00
Yang Wang
4ab95fa3e4 Fix Nano TensorFlow Doc Link (#4634) 2022-05-19 09:30:30 +08:00
Yang Wang
aabeb3fe35 add nano documentation pages to readthedocs site (#4619)
* add nano documentation pages to readthedocs site

* fix file name

* refine title

* fix typo
2022-05-18 09:22:02 +08:00
Yang Wang
210677a295 Add nano documentation for pytorch training quickstart (#4577)
* Add nano documentation for pytorch training quickstart

* fix some typo

* break pytorch training and inference to two files

* simplify trainer import

* fix train doc
2022-05-16 14:14:30 +08:00
Yang Wang
25982b0d16 Add Nano TensorFlow Training QuickStart Doc (#4591)
* Add Nano TensorFlow Training QuickStart Doc

* fix typo

* break training and inference to two files
2022-05-16 10:46:16 +08:00
Yang Wang
0656804f56 Add windows guide to nano overview (#4599)
* Add windows guide to nano overview

* add source cmmd
2022-05-16 10:45:12 +08:00
Yang Wang
fd1da60251 Add Nano doc structure and Nano overview (#4504)
* Add Nano doc structrue and nano overview

* add sections

* add unset environment variable instructions

* restructure

* address comments
2022-05-09 17:12:44 +08:00