Commit graph

20 commits

Author SHA1 Message Date
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
Yuwen Hu
3a19ebbfbf Add ipython extension for rendering code blocks in excuted notebooks properly in our readthedocs project (#5757) 2022-09-14 17:25:55 +08:00
Yuwen Hu
57e46c6160 [Documentation] Add Extension nbsphinx-link (#5596)
* Add extension nbsphinx-link: link notebook out of the sphinx root folder to the sphinx project

* Link Notebook custom.ipynb directly from python folder to the sphinx project

* Link Notebook seq_and_func.ipynb directly from python folder to the sphinx project

* Small title fix

* Make interactive graphs visible in readthedocs webpage for seq_and_func.ipynb

* Regenerate outputs for custom.ipynb and remove parts of them
2022-09-01 11:54:24 +08:00
Junwei Deng
b2dac661db Chronos: add quick tour page (#5217)
* add quick tour

* update some md

* update quick tour

* add some contents

* add some changes

* change link

* add new file

* fix some typo

* fix typo

* fix typo

* fix typo

* fix typo

* fix typos

* fix bug

* fix typos

* fix typos

* fix bug

* fix bug

* fix bug

* fix bug

* add information

* fix type

* add description

* add more content

* add some bug fix

* update document

* update

* update page

* fix typo

* update typos

* fix typo
2022-08-09 12:16:38 +08:00
Mingzhi Hu
5506f60732 Nano: Add TensorFlow step by step tutorials (#5156)
* Add tutorial notebook

* Add md

* Test on readthedocs

* Fix markdown

* fix md

* update notebooks

* update requirements version in doc

* update

* add and update tutorial

* add unit test for tensorflow tutorial

* reduce test time

* reduce test time

* update shell

* update action

* Update tutorial

* reduce ut time

* reduce ut time

* reduce ut time

* reduce ut time

* reduce ut time

* Update

* Fix shell

* update

* update

* rollback requirements

* Update

* Update

Co-authored-by: pinggao187 <ping.gao3@pactera.com>
2022-08-09 09:03:45 +08:00
Yuwen Hu
a4bbadeb61 [Nano] Integrate ipynb files into ReadtheDocs (#5222)
* Add nbsphinx extension for docs

* Add specific ipynb files to readthedocs folder and add links to Nano Tutorials index page

* Disable execution of ipynb notebook

* Remove outputs of two ipynb files

* Rename titles and add navigation texts to seq_and_func.ipynb under readthedocs folder

* Rename titles and add navigation texts to custom.ipynb file under readthedocs folder
2022-08-01 13:06:03 +08:00
Shengsheng Huang
928b016d88 rollback tensorflow 1.15 dependency (#5232) 2022-07-28 11:25:43 +08:00
Shengsheng Huang
e4ca63a97f [doc] move current toc out of readthedocs landingpage (#5201)
* remove toc from landing page

* update extension version

* resolve version conflict

* remove toc in page

* fix toc

* fix toc

* revise toc

* revise toc

* revise toc

* revise toc

* revise toc

* revise toc

* revise toc

* revise toc

* revise toc
2022-07-26 13:17:42 +08:00
pinggao187
00a6a2a22f Readthedoc: update requirements version in doc (#5181)
* update requirements version in doc

* update
2022-07-25 10:09:18 +08:00
Junwei Deng
8f177b90b7 Readthedoc: fix markdown version in doc (#5164)
* fix markdown version

* fix md version
2022-07-22 10:43:28 +08:00
Shane Huang
3f576e5ffa Nano docs: add hpo api docs (#4901)
fix hpo api docs
2022-07-04 14:37:13 +08:00
Shane Huang
b53074af53 fix docs (#4992) 2022-07-01 12:14:43 +08:00
Shane Huang
41a28c317f update visualization docs (#4980)
* update docs
2022-06-30 23:08:12 +08:00
Yang Wang
20ad708010 Add Nano PyTorch API Doc (#4730)
* add trainer api doc

* add index and fix trainer

* fix doc

* reset

* fix conflict

* fix import
2022-06-08 17:45:24 +08:00
liangs6212
0af87a18c6 Chronos: Fix readthedocs.io build error (#4720)
* add pickle5 version

* fix doc issue

* fix import bigdl.nano in doc

* renamed basepytorchmodel to baseautomodel

* renamed again
2022-05-30 17:52:20 +08:00
Shan Yu
5500241dca remove tsfresh to solve doc building conflict for protobuf version (#4047) 2022-02-16 15:49:09 +08:00
Shan Yu
ce7a812623 Upgrade Ray version to 1.9.2 in documents and setup (#4037)
* upgrade ray 1.2.0 to 1.9.2 in documents

* change ray version 1.9.0 to 1.9.2 in setup
2022-02-16 12:21:58 +08:00
Junwei Deng
d58d47d2fc Chronos: Fix forecaster doc (#3690)
* add torchmetrics in doc

* add nano

* add doc fix
2021-12-09 16:27:28 +08:00
liangs6212
e43a06b13a Add AutoXGBoost API Guide (#3376)
* add auxo-xgb api guide

* add example code

* change description

* add "\n"

* fix paragraph
2021-11-04 14:41:34 +08:00
gaoping
21543a05ed add docs 2021-10-12 11:06:44 +08:00