Commit graph

59 commits

Author SHA1 Message Date
liangs6212
da7b30529b Nano: Update the Nano installation panel (#7015)
* update installation panel

* fix typo

* fix typo again

* fix typo

* experimental change

* fix typo

* fix known issues

* update

* update subsections

* update typo

* update according to comment

Co-authored-by: TheaperDeng <theaperdeng@outlook.com>
2022-12-26 15:43:36 +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
935fc48354 Nano: update PyTorch inference key feature doc (#6938)
* upddate installation

* update

* update runtime acceleration

* update link in rst

* add bf16 quantization and optimize()

* update based on comment

* update

* update based on comment
2022-12-22 13:34:18 +08:00
Yishuo Wang
3b6c56b505 Nano: update nano known issue (#7063) 2022-12-22 09:53:05 +08:00
Yishuo Wang
0a62df22aa Nano: quick fix typo (#7064) 2022-12-21 16:31:15 +08:00
Junwei Deng
dea7b8f9f2 Nano: update train pytorch key feature doc (#6906)
* update train doc

* update train page
2022-12-19 15:51:19 +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
Yishuo Wang
7e180d028e Nano: update tensorflow examples (#6935) 2022-12-12 13:56:05 +08:00
Yishuo Wang
7e2742cace Nano: Update examples and tutorials (#6888) 2022-12-08 11:23:48 +08:00
liangs6212
ae7160790d Doc: Nano installation panel (#6852)
* add nano installation panel

* try fix

* try fix again

* fix typo

* add versions

* try fix second

* try fix second again

* fix col width

* rollback

* rollback again

* fix syntax error

* fix syntax error again

* fix syntax error last

* fix syntax

* fix syntax

* fix syntax again

* add some comment

* try fix

* try fix

* try fix again

* try fix

* fix typo

* fix some error

* fix typo

* some optimization

* change width

* change width again

* change width again

* change width again

* last width change

* fix description error

* change inference default to yes

* switch inferenceyes and inferenceno
2022-12-07 14:30:11 +08:00
Junwei Deng
87507ba715 Nano: add partial m-series chip support for tensorflow (training and installation) (#6520)
* add m1 chip support

* fix setup
2022-11-30 13:18:00 +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
Yishuo Wang
62694b420e Nano: fix onnx quantization document issue (#6662) 2022-11-17 15:34:45 +08:00
Hu, Zhaojie
607db04ad7 [Nano] Openvino model inference notebook example with Nano (#5745)
* add nano notebook example for openvino ir

* add basic example for openvino model inference

* add notebook example for sync inference and async inference

* add notebook to documentation

* update explanation for async api

* try to fix code snip

* fix code snip

* simplify async api explanation

* simplify async api explanation

* adapt new theme
2022-11-16 10:10:07 +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
Yishuo Wang
6a8cdd71de fix torch_nano document link error and small change (#6257) 2022-10-24 14:04:02 +08:00
Ruonan Wang
f54b9b1915 Nano : update installation guide to nightly-build version (#6203)
* update install.md

* update examples

* update doc based on comments

* update link
2022-10-24 14:01:29 +08:00
Hu, Zhaojie
a0fa1694b5 [Nano] : Add howto guides for InferenceOptimizer.optimize (#6136)
* howto guide for InferenceOptimizer

* fix format in notebook

* rename notebook & add github workflow

* fix doc issue

* fix notebook

* fix typo

* remove ipykernel

* update notebook

* adapt new theme

* fix typo & remove necessary numpy
2022-10-22 10:44:50 +08:00
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
Yuwen Hu
331c3054d9 [Nano] How-To Guides: Training - TensorFlow (#5836)
* Add basic guides structure of Training - TensorFlow

* Add how-to guides: How to accelerate a TensorFlow Keras application on training workloads through multiple instances

* Change import order and add pip install for tensorflow-dataset

* Diable other nano tests for now

* Add github action tests for how-to guides Tensorflow training

* Use jupyter nbconvert to test notebooks for training tensorflow instead to avoid errors

* Add how-to guide: How to optimize your model with a sparse Embedding layer and SparseAdam optimizer

* Enable other nano tests again

* Small Revision: fix typos

* Small Revision: refactor some sentences

* Revision: refactor contents based on comments

* Add How-to guides: How to choose the number of processes for multi-instance training

* Small Revision: fix typos and refactor some sentences

* Make timeout time for github action longer for TensorFlow, 600s->700s
2022-09-26 15:40:22 +08:00
Ruonan Wang
55c793c455 Nano : Update pytorch inference QuickStart with InferenceOptimizer (#5899)
* replace Trainer with InferenceOptimizer

* add warning note for deprecation of trainer.trace / trainer.quantize
2022-09-26 09:52:34 +08:00
Yuwen Hu
12c12a1058 [Nano] How-To Guides: Training - PyTorch Lightning (#5643)
* Rearrange file structure for PyTorch Inference for docs and add titles for PyTorch-Lightning Training

* Add How-to guide: How to accelerate a PyTorch-Lightning application on training workloads through Intel® Extension for PyTorch*

* Add how-to guide: How to accelerate a PyTorch-Lightning application on training workloads through multiple instances

* Revise: remove '-' in 'PyTorch-Lightning' and some other changes

* Add How-to guides: How to use the channels last memory format in your PyTorch Lightning application for training

* Add how-to guide: Use BFloat16 Mixed Precision for PyTorch Lightning Training

* Add How-to guide: How to accelerate a computer vision data processing pipeline

* Small Revision: change comments in several code cells

* Disable other nano tests temporarily

* Add github action tests for Nano Training PyTorch Lightning tests

* Enable other nano tests again

* Small revisions: typos and explanation texts changes

* Revise: update based on comments
2022-09-15 15:26:11 +08:00
Yishuo Wang
62b8aa8703 fix nano UT (#5650) 2022-09-06 17:09: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
Yuwen Hu
cc540d0c34 Update "Open in Colab" button in notebooks (#5452)
* Update open in colab button from HTML-style hyperlinks to markdown image with link for notebooks in readthedocs folder

* Update "Open in Colab" button for notebooks under python folder with markdown image with link
2022-08-18 14:55:20 +08:00
Yishuo Wang
e62b8d1fc5 Automatically unwrap attributes access of _LiteModule (#5392)
* automatically unwrap attributes access of _LiteModule and add test for it
* delete redundant documents
2022-08-18 10:57:52 +08:00
Yishuo Wang
19e6099483 supplement the doc of torchnano (#5348) 2022-08-10 09:54:56 +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
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
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
Yang Wang
01e6c62a68 Fix typo in nano documentation (#5036) 2022-07-07 09:43:10 +08:00
Shane Huang
16005ada17 add hpo tutorial (#5011) 2022-07-04 17:23:33 +08:00
Shane Huang
53ba2d8279 fix docs (#5009)
* fix docs

* add resources
2022-07-04 16:59:10 +08:00
Mingzhi Hu
798345123f Nano: Update Nano PyTorch quick start doc (#4897)
* add BigDL-Nano PyTorch Quickstart

* Update BigDL-Nano PyTorch Quickstart

* Update BigDL-Nano PyTorch Quickstart

* Add Nano inference quickstart
- add inference onnx quickstart
- add inference openvino quickstart
- add quantization inc quickstart
- add quantization inc onnx quickstart
- add quantization openvino quickstart

* update quickstart

* update quickstart

* Add Nano quantization quickstart

* update nano docs

* Update docs

* Update Nano OpenVINO tutorial

* Update

* Update index.md

* Resize Images

* Resize Images

* Update

* Update Nano docs

* Update nano documents

* Update doc & notebook

* clear output of cells

* add unit tests for tutorial notebooks

* fix errors in yaml

* fix error in notebook

* reduce quantization time

* Update yaml

* Add unit test for tutorial

* Add tests for tutorial

* fix shell
2022-07-04 10:10:21 +08:00
Shane Huang
41a28c317f update visualization docs (#4980)
* update docs
2022-06-30 23:08:12 +08:00
Mingzhi Hu
145216bfc1 Update pytorch to 1.11 (#4854)
* update setup and action

* fix yml

* update yml

* test yml

* update docs

* update notebook requirements

* test notebooks unit test

* reset yml

* delete comments

* fix yml

* fix errors in setup.py

* fix setup.py

* specify the version of IPEX
2022-06-24 16:38:48 +08:00
Zhentao Chen
7dcd79366f doc fix (#4829) 2022-06-15 08:23:01 +08:00
Zhentao Chen
e7c7ab2b8e [Nano] add tf inference doc (#4797)
* add tf inference doc

* fix doc

* grammarly check

* add sequential
2022-06-13 08:54:48 +08:00
Mingzhi Hu
2c4623f8da Update pytorch_train.md (#4786)
* Update pytorch_train.md

Add description about torchvision version

* Update pytorch_train.md
2022-06-09 08:39:44 +08:00
Zhentao Chen
900711f1b3 [Nano] add pytorch inference doc (#4656)
* pytorch inference doc init commit

* quantization with tuning

* fix grammarly

* remove val_dataloader

* specify version
2022-06-02 14:42:00 +08:00
Shane Huang
8ced71c488 revise hpo doc (#4735) 2022-05-31 17:35:52 +08:00
Shane Huang
e24859c39b add resume and parallel search docs (#4734) 2022-05-31 17:08:23 +08:00