Commit graph

33 commits

Author SHA1 Message Date
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
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
Shane Huang
353e7ffbdf [Nano HPO] revised user guide (#4666)
* revise doc

* revise doc

* revise docs again
2022-05-24 14:42:42 +08:00
Shane Huang
993c80b427 [Nano HPO] user guide (#4639)
* add initial version of hpo doc

* modify the doc index

* revised doc

* revise docs

* revise docs
2022-05-23 21:33:27 +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