Commit graph

26 commits

Author SHA1 Message Date
Jason Dai
271d82a4fc
Update readme (#11357) 2024-06-19 10:05:42 +08:00
Yuwen Hu
e0ea7b8244
[Doc] IPEX-LLM Doc Layout Update (#10532)
* Fix navigation bar to 1

* Remove unnecessary python api

* Fixed failed langchain native api doc

* Change index page layout

* Update quicklink for IPEX-LLM

* Simplify toc and add bigdl-llm migration guide

* Update readthedocs readme

* Add missing index link for bigdl-llm migration guide

* Update logo image and repo link

* Update copyright

* Small fix

* Update copyright

* Update top nav bar

* Small fix
2024-03-25 16:23:56 +08:00
Yuwen Hu
566e9bbb36 [LLM Doc] Restructure (#10322)
* Add quick link guide to sidebar

* Add QuickStart to TOC

* Update quick links in main page

* Hide some section in More for top nav bar

* Resturct FAQ sections

* Small fix
2024-03-05 14:35:55 +08:00
Yuwen Hu
200fc6a1ee [LLM] Fix llm api doc rendering failure due to ipex auto importer (#9877) 2024-01-10 14:53:25 +08:00
Kai Huang
1b65288bdb Add api doc for LLM (#8605)
* api doc initial

* update desc
2023-08-08 18:17:16 +08:00
Yuwen Hu
9ffd1f6dda Mock prophet as doc building failed (#8083) 2023-04-19 17:24:58 +08:00
Yuwen Hu
e5e5c06863 Mock sigfig for doc build to fix the failed rendered API doc (#7800) 2023-03-08 10:00:23 +08:00
Yuwen Hu
c31136df0b [Nano] Improve How-to Guides Navigations (#7396)
* Remove deprecated option enable_auto_doc_ref for recommonmark

* Add first level navigation structure for Nano how-to guides

* Update navigation for How-to Training part

* Update navigation for How-to Inference part

* Update navigation for How-to Preprocessing/Install part and other small fixes

* Fix wrong link path caused by position changes of how-to install related guides

* Small fix
2023-02-03 09:37:10 +08:00
Yuwen Hu
8d6c43dd09 Mock module cpuinfo for fixing missing Nano/Chronos api doc (#6655) 2022-11-17 11:23:09 +08:00
Yuwen Hu
7cb86aeddd [Doc] Enable Mermaid diagrams in our documentation (#6450)
* Add sphinxcontribute-mermaid extension

* Add manual link for mermaid.js

* Load mermaid.js before require.js to avoid errors

* Update documentation guide for the usage of mermaid diagram in our doc

* Resolve error caused by double loaded mermaid.js

* Small fixes

* Small fix based on comments
2022-11-04 15:38:15 +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
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
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
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
Shane Huang
41a28c317f update visualization docs (#4980)
* update docs
2022-06-30 23:08:12 +08:00
David smurf
500b7bbe99 Chronos: add tf forecaster doc (#4923) 2022-06-27 11:33:41 +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
Song Jiaming
a83ab371d2 add serving index to readme (#3648) 2021-12-02 16:57:17 +08:00
Yina Chen
98ba6d5e80 Update orca & friesian readthedocs (#3182)
* update readthedocs

* add path

* update
2021-10-22 14:56:00 +08:00
liangs6212
6137a08ddf Chronos: Fix the display problem of API doc (#3208)
* fix rst path

* recipe api doc error

* rename title

* Uniform name format
2021-10-22 12:15:07 +08:00
pinggao187
c876e474af update readthedocs conf (#3158)
reviewed, LGTM。  Co-authored-by: gaoping <pingx.gao@intel.com>
2021-10-20 18:28:57 +08:00
helenlly
2050ea16a6 Update conf.py
changed words with "Analytics Zoo" to "BigDL"
2021-10-20 14:55:45 +08:00
gaoping
21543a05ed add docs 2021-10-12 11:06:44 +08:00