Commit graph

42 commits

Author SHA1 Message Date
Yuwen Hu
5e9ef7b553 [Nano] Add a generalized how-to guide for accelerate PyTorch cv data process pipeline (#7125)
* Restyle blockquote elements in web

* Add a generalized how-to section for preprocessing, including the data process accelerastion for PyTorch

* Small fix

* Update based on comments and small typo fixes

* Small fixes
2023-01-05 18:07:10 +08:00
Yuwen Hu
bfca337d09 [Nano] Add how-to guide for TensorFlow Keras training using bf16 (#7169)
* Add basic doc structure for bf16 tf training how-to guide, and change the incorrect order of tf inference guides in toc

* Add how-to guide for tf bf16 training

* Add warning box for tf bf16 hardware limitations

* Add a print message to show the default policy of model after unpatch

* Small fixes

* Small github action fixes for tf bf16 training how-to guide

* diable action test for tf bf16 train for now, due to the core dumped problem on platforms without AVX512

* Updated based on comments
2023-01-05 17:59:43 +08:00
Henry Ma
18ae409b7c [Nano] add how-to-guide for tensorflow inference by onnxruntime and openvino (#7149)
* Feat(docs): add how-to-guide for tensorflow inference by onnxruntime and openvino

* fix bugs for index.rst

* revise according to PR comments

* revise minor parts according to PR comments

* revise bugs  according to PR comments
2023-01-04 23:43:48 +08:00
Yishuo Wang
ab9a3b69fb Nano: Add CUDA patch key feature (#7089) 2023-01-04 10:53:27 +08:00
Junwei Deng
56e94eda59 Chronos: add forecaster alg choose guide and some cleaning for how to guide (#7139)
* fix format

* fix

* update

* update
2023-01-03 15:00:27 +08:00
Kai Huang
264451c6bd Merge Orca quick starts and how to (#7133)
* add tf2 to howto

* update tf2

* remove

* modify sidebar

* remove quickstart

* minor
2022-12-30 16:05:15 +08:00
Yuwen Hu
37b0c6fa50 [Nano] How-To Guides: Convert to TorchNano & use @nano decorator (#5984)
* Add how to guide: How to convert your PyTorch code to use TorchNano for training acceleration

* Small nano how-to index format update for openvino inference

* Update based on comments

* Updated based on comments

* Add how-to guide: How to wrap a PyTorch training loop through @nano decorator

* Add reference to TorchNano guide in @nano guide

* Some small fixes and updates

* Small typo fix: bulit -> built

* Updates based on comments

* Remove validation dataloader based on comments

* Order change of two guides

* Update based on comments
2022-12-26 15:36:53 +08:00
Ruonan Wang
14cf4aff72 Nano: Troubshooting guide for BigDL-Nano (#6910)
* add troubshooting guide

* add more cases

* update style

* update

* update style

* update two cases

* update

* add two issue
2022-12-26 10:02:44 +08:00
Ruonan Wang
b3feb53c4a Nano: add key feature and how to guide for context manager (#6897)
* add key feature and how to guide for context manager

* update key feature for multi models

* update based on comment

* update

* update based on comments

* update

* update
2022-12-13 16:57:52 +08:00
Yishuo Wang
664dfbe7ef Nano: Add key feature and how to guide for multi-instance inference (#6901) 2022-12-13 14:18:26 +08:00
Qiyuan Gong
3571247d65 [PPML] Attestation basic (#6778)
* Add attestation basic doc to readthedoc
2022-11-28 13:26:52 +08:00
WangJun
bf5ccae4ef [Nano] add how to guide save and load jit, ipex, onnx, openvino (#6659)
* add how to guide:
* acclerate with jit_ipex
* save and load jit, ipex, onnx, openvino
* add these five above .nblink files
;

* add index of sl files

* clear all the output & fix the bug of title

* remove extra blank indent

* format the jupter with prettier

* fix the bug of error words

* add blank line before unorder list

* * remove the normal inference in accelerate using jit/ipex;
* add note to example why we should pass in the orginal model to get the optimized one in sl ipex

* fix:new pip install shell cmd  & indent improve
2022-11-25 15:47:15 +08:00
Qiyuan Gong
621168ce2e [PPML] Move dev guide to tutorial (#6765)
* Move dev guide to tutorial & examples.
2022-11-25 15:02:11 +08:00
binbin Deng
df775d172e Chronos: benchmark tool user guide (#6668) 2022-11-25 11:25:34 +08:00
Cengguang Zhang
ca3b088522 Doc: update sidebar and quickstarts order. (#6743)
* doc: update sidebar and quickstarts order.

* fix: adjust quickstart order.

* fix: fix typo.

* fix: fix typo.
2022-11-23 18:57:11 +08:00
Junwei Deng
022d8d661c Chronos: add a how to guide to help users replay their forecaster with pre/post processing in production env (#6258)
* add notebook

* add updates

* rm output

* fix link

* add fix

* fix index
2022-11-17 19:28:34 +08:00
Kai Huang
c80bb4b876 Expose k8s tutorial to docs (#6596) 2022-11-14 20:35:38 +08:00
Ruonan Wang
dbce8f13e0 Chronos : How to preprocess my data guide (#6446)
* add introduction

* finish basic version

* update nblink

* update based on comments

* update css
2022-11-11 16:30:15 +08:00
Juntao_Luo
4f3c27bde0 Chronos: upload prediction how-to-guide. (#5959)
* Upload:how_to_use_forecaster_to_predict_future_data how to guide.

* Update: update hyperlink in notebook.

* Update: update how-to-guide

* Update: update guide with pure prediction.

* tmp save

* test

* update how to predict

* make cell hidden

* update

* update toc

* update based on coments

Co-authored-by: ruoan1.wang <ruonan1.wang@intel.com>
2022-11-09 09:20:19 +08:00
David smurf
4403c7727f Chronos: forecaster save/load how-to guide (#5684)
* how to save and load forecaseter

* add  doc of forecaster save and load

* update save and load notebook

* update notebook

* update link

* fix typo

Co-authored-by: ruoan1.wang <ruonan1.wang@intel.com>
2022-11-08 21:49:23 +08:00
Qiyuan Gong
0a49cd03bf [PPML] Reorg Readthedoc tutorial & menu (#6476)
* Change User Guide to Introduction
* Add Installation
* Refine toc and examples
* Refine title
* Add FAQs for Installation
2022-11-08 16:26:59 +08:00
Cengguang Zhang
5346ef45d8 Orca: update orca-in-5-minutes to tf2 estimator. (#6404)
* feat: update orca-in-5-minutes to tf2 estimator.

* fix: fix code and tensorflow version.

* fix: fix typo.

* fix: add config in estiamtor construction.

* feat: add random split to dataframe.

* fix: fix typo.

* feat: add test data in fit.

* fix: update link branch to main

* fix: fix typo.
2022-11-04 16:46:09 +08:00
Cengguang Zhang
916fdecd27 Orca: Document polishing (#6382)
* fix: delete redundant quick examples.

* feat: add How-to Guides with use cases.

* fix: _toc.yml

* fix: fix typo.

* fix: fix typo and file location.

* fix: add quickstarts to _toc.yml
2022-11-04 15:02:37 +08:00
Hu, Zhaojie
84f5106a73 [Chronos]: Add how-to guides for exporting torchscript files to disk (#6319)
* add how-to guide for exporting to torchscript files

* fix nblink

* update description

* add onnxruntime-extensions
2022-11-04 14:41:42 +08:00
Yuwen Hu
95ef573fc4 [Doc] Add contributor guide for writing new documentation (#6254)
* Revise toc tree & add draft version for document guide

* Add more contents and revise documentation guide

* Rename new file for documentation guide

* Add some new contents and try to change html tables to plain text tables for generated styles

* Change back to html table with specified css

* Add some new contents and small revision

* Revise contributor index page

* Minor typo fixes for landing page quicklinks

* Revise based on comments

* Add rst card components and small revisions
2022-10-31 16:29:25 +08:00
Qiyuan Gong
56fcec2314 [PPML] Fix deploy in production link (#6363)
* Fix deploy in production link. Thanks to @Oscilloscope98
2022-10-31 14:13:46 +08:00
Xiangyu Tian
df3c04199f Add BigDL-PPML-Azure-Occlum-Example to readthedocs (#6292)
* Init

* Refine

* Refine

* Fix
2022-10-27 16:50:34 +08:00
Hu, Zhaojie
662628f4db Chronos: Add how-to guides for exporting ONNX/OpenVINO files to disk (#6234)
* create how-to guides for export model files to onnx/openvino

* add how to export onnx files

* add to doc

* hide the training process

* fix

* add how to export openvino files

* fix onnx

* fix nblink

* fix onnx

* change import

* fix onnx

* update some descriptions

* update yml file
2022-10-25 16:24:35 +08:00
Yuwen Hu
89f97fed01 Move in-file toc to yml file except for API related toc (#6273) 2022-10-25 11:00:57 +08:00
Kai Huang
ea164651ee Polish Orca Doc (#6266)
* fix doc

* add tutorial index

* remove

* fix

* remove

* update
2022-10-24 18:03:39 +08:00
Ruonan Wang
100f2df428 update doc (#6261) 2022-10-24 14:55:23 +08:00
Qiyuan Gong
5ed2a33072 [PPML] Deployment with customer image (#6132)
* PPML deployment in 2 stages
* Add MRENCLAVE plot
* Add attestation
* Add index
2022-10-21 22:08:54 +08:00
Qiyuan Gong
b5d7b3183c [PPML] Refine SGX Driver installation doc (#6167)
* Add install from install package
* Rename file to install_sgx_driver
* Rename title to Install SGX Driver on Xeon Server
* Add vmlinux-gdb issue
2022-10-19 14:42:35 +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
Junwei Deng
6b337b92be Chronos: how to guide page cleaning (#5657)
* update

* add nblink

* windows guide fix

* add some updated

* update chronos

* add update image

* add new image

* add updates

* add update

* add new image

* fix typo

* fix notebook location

* add new index

* update

* fix some doc

* update tree

* fix typo
2022-09-11 17:51:13 +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
Chaselzxy
b11496db60 Chronos: How-to-Guides (How to train forecaster on single node) (#5224)
* how to train forecaster

* add a notebook

* add new notebook

* add index

* fix colab link

* change content

Co-authored-by: Xinyi Zhang <xinyi1.zhang@intel.com>
Co-authored-by: theaperdeng <theaperdeng@outlook.com>
2022-08-17 20:11: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
Ziyao Peng
41f602fcec Chronos: Add a page 'Windows User Guide.md' to ReadTheDocs (#5263)
* Add files via upload

* Update _toc.yml

* Update windows_guide.md

* r

* Delete windows_guide.html
2022-08-08 17:41:29 +08:00
Cengguang Zhang
50c180520e Docs: Bigdl known issues docs (#5204)
* docs: add dynamic allocation to FAQ/known issues in docs

* style: reformat the code

* docs: add known_issues to _toc.yml

* docs: remove known-issues.md

* fix: delete unnecessary issues

* fix: refine known_issue format and add barrier mode configuration.

* fix: reformat known_issues.md

* fix: update known_issues.md

* fix: modify known_issues.md

* fix: amend the wording
2022-07-28 16:18:18 +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