Commit graph

203 commits

Author SHA1 Message Date
Ruonan Wang
2f1f3ba114 Chronos : Penalize underestimation example (#5627)
* add example

* remove valid dataset

* fix typo

* modify parameters and graph

* update based on comment

* modify index link

* modify js

* update
2022-09-02 15:46:12 +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
Cengguang Zhang
f8f717a684 Doc: update hadoop document. (#5623)
* doc: update hadoop document.

* fix: fix wording.

* fix: fix wording.

* fix: fix wording.
2022-09-02 08:05:43 +08:00
Juntao_Luo
0f1cfd82ff Chronos: installation panel enhancement (#5588)
* Update:installation panel enhancement
Left a bug to fix and install CMD to revise.

* Bugfix: Fixed a bug when using Firefox browser to use the install guide form.
Fixed the bug that the table's background color may be changed by mistake on Firefox browser.

* Update: update panel as comment required.

* Bugfix: fixed a bug in js file that will show wrong cmd when clicking 'windows' or 'docker'.

* Bugfix: fixed the bug that 'cmd' shows incorrectly when clicking 'prophet' and 'ARIMA'.
2022-09-01 21:11:59 +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
Jason Dai
9e76c7e16e Update powered-by.md 2022-08-31 21:20:56 +08:00
Jason Dai
692f79a1c7 Update powered-by.md 2022-08-31 20:57:42 +08:00
Ruonan Wang
3df26cc9ed Chronos : add [how to tune a forecaster model] notebook (#5399)
* add how_to_tune_a_forecaster_model notebook

* modify step1: data preparation

* update based how to train

* modify a bug of summary

* update based on comment

* move to howto

* fix typo

* add file

* update based on comments

* rename the tile
2022-08-30 22:24:49 +08:00
Cengguang Zhang
57d45e5deb Orca: add save and load model doc to PyTorch Estimator quick-start. (#5504)
* feat: add save and load model doc to pytorch estimator quickstart.

* fix: fix typo.

* fix: fix typo

* fix: fix typo.

* feat: add doc to ray backend quickstart

* fix: fix typo.

* feat: add doc to ray backend quickstart
2022-08-24 13:48:32 +08:00
Juntao_Luo
584ee6045c Chronos: update js, css and md files to add filter function in tutorial page. (#5506) 2022-08-23 12:50:29 +08:00
Cengguang Zhang
c94e934068 Orca: update known-issues. (#5505)
* fix: update known-issues.

* fix: fix wording.
2022-08-23 11:21:37 +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
Qiyuan Gong
df75c72d91 Add Key generation suggestion into document (#5446)
* Add SSL and AES Key generation suggestion into document.
2022-08-17 22:55:53 +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
Cengguang Zhang
241b0f1712 Docs: fix typo and quickstart code branch. (#5414) 2022-08-16 16:20:46 +08:00
Cengguang Zhang
6af23499e7 Docs: add save and load model docs. (#5397)
* docs: add save and load model docs.

* fix: update code style.

* fix: update code style.

* fix: fix typo and modify wording.

* docs: add save model example to notebook.

* fix: fix typo.
2022-08-16 15:23:30 +08:00
shaojie
611c9aefdf fix Notebook issues (#5344)
* fix Notebook issues

* update start-notebook scripts to add token and port parameter.

* update start notebook scripts

* test start notebook scripts and deployment yaml file

* update image tag to latest

* update deployment file,README and start-notebook script file

* update README

* update README

Co-authored-by: baishaojie <shaojiex.bai@intel.com>
2022-08-16 10:39:39 +08:00
Jason Dai
bdce772965 Update powered-by.md 2022-08-16 07:12:36 +08:00
Cengguang Zhang
2c0424e964 Docs: update orca known issues (#5395)
* docs: update known issues

* fix: add example to known issue

* fix: add example to known issue

* fix: fix typo

* fix: modify issue description.

* fix: fix typo.

* fix: fix typo.
2022-08-15 18:20:45 +08:00
Jiao Wang
a440a05b0c Azure PPML doc update (#5386)
* update

* update
2022-08-12 15:44:33 -07:00
Song Jiaming
362674ee1c Add a ssl/tls section of Secure Your Devices README (#5366)
* Add a ssl/tls section of Secure Your Devices README
2022-08-12 10:07:16 +08:00
Juntao_Luo
dfb0946075 Chronos: Update Chronos install guide form's js and css file. (#5360)
* Update chronos_installation_guide.css

* Update chronos_installation_guide.js

* Update chronos.md

* Change border color

* Deleted test text in '2. Install' title

I changed the title in last commit to check if my build in readthedoc web works fine. Now I delete it.

* Update button css selector

Revised the button selector to avoid influencing other buttons' style on the web.

* Update #cmd height

* Update as pull-request comment required.

1, disable other options when users choose windows, and guide users to https://bigdl.readthedocs.io/en/latest/doc/Chronos/Overview/windows_guide.html in "Install CMD"
2, guide users to https://bigdl.readthedocs.io/en/latest/doc/Chronos/Overview/chronos.html#tensorflow-backend in "Install CMD" when tensorflow is chosen.
3, guide users to https://github.com/intel-analytics/BigDL/tree/main/docker/chronos-nightly in "install CMD" when docker is chosen.

* Update css file to meet the comment requirements

Make the disabled items' background darker to have a better vis experience. 
Have a larger fontsize.

* Update js file to meet the comment requirement.

 Make the disabled items' background darker to have a better vis experience.

* Update border css settings.

Changed table border settings since last version looks not good.

* Change pmdarima to ARIMA

* Update visuals.

The button now has a hovering style, indicating the user that it can be clicked.
2022-08-11 17:30:03 +08:00
Jiao Wang
c8dd8d6e5e update (#5362) 2022-08-10 12:56:41 -07:00
Yishuo Wang
19e6099483 supplement the doc of torchnano (#5348) 2022-08-10 09:54:56 +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
David smurf
99bef5579d Chronos: XShardsTSDataset user guide (will be reused in how-to handle large data) (#5196)
* new xshards_doc

* update

* update

* update

* update

* update

* update

* update

* udpate xshardstsdataset doc

* fix typos

* fix some typos

Co-authored-by: theaperdeng <theaperdeng@outlook.com>
2022-08-09 09:53:00 +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
Cengguang Zhang
985aec4425 Orca: add grpc error to orca known issues (#5309)
* feat: add grpc error to orca known issues

* refactor: update short name and style.

* refactor: refine error explanation

* Update known_issues.md

* Update known_issues.md
2022-08-08 18:10:29 +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
Ruonan Wang
f682f79166 Chronos : add multi-objective HPO with latency tutorial (#5307)
* add mo hpo with latency tutorial

* update according to comment

* remove test_data

* add license
2022-08-08 14:28:29 +08:00
Junwei Deng
9dbe743ea4 Chronos: add more installation options (#5175)
* add installation options

* add new tested setup.py and quickstart changes

* add installation guide

* add some doc fix

* chronos typo

* fix typos

* fix pep8

* fix accord comments
2022-08-05 14:11:48 +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
Kai Huang
70b2070e4d Update Python User Guide (#5275)
* add doc

* fix
2022-08-02 12:24:52 +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
Kai Huang
cda8967416 Fix libhdfs known issue doc (#5257)
* fix doc

* minor
2022-08-01 20:28:36 +08:00
joan726
df2a7dcef0 Update powered-by.md (#5261) 2022-08-01 15:03:48 +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
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
Jiao Wang
f5909aee9f Update Azure PPML docs (#5163)
* update doc

* update

* update

* update
2022-07-25 12:59:34 -07:00
Zhao Changmin
d120db025e Mirgate Terminal Setup Steps into Developer Guide (#5133)
* correct prepare_env.sh path

* Alternative way to prepare envs
2022-07-25 15:35:00 +08:00
Yuwen Hu
a44571f8a3 Chronos: Correct typo for Chronos User Guide (#5166) 2022-07-22 14:49:43 +08:00
obarut
7232f23176 Chronos: installation user guide typo (#4915)
* avoid installation of python 3.7.0 and typo

python 3.7.0 and 3.7.1 is problematic with Ray (happens while orca context being init.)

* go back to py 3.7

if base conda env is not py 3.7.0 or 3.7.1, then no pb.
2022-07-12 19:57:30 +08:00
plusbang
fa3c7f8aff chronos: user guide python version note change (#5067)
Co-authored-by: binbin <binbin1.deng@intel.com>
2022-07-11 17:10:19 +08:00
Shaojun Liu
98f1b7a406 [ppml] add ppml cli into docker image (#5056)
* add bigdl-ppml-submit.sh into ppml graphene image

* remove ppml-spark-submit.sh since it was replaced by bigdl-ppml-submit.sh

* update ppml-spark-submit.sh to bigdl-ppml-submit.sh
2022-07-08 17:09:47 +08:00
Yang Wang
01e6c62a68 Fix typo in nano documentation (#5036) 2022-07-07 09:43:10 +08:00
Mingzhi Hu
2157af9a03 Add rst (#5027) 2022-07-06 14:21:11 +08:00
Junwei Deng
d904070154 Chronos: fix some api document tag (#5017) 2022-07-05 10:41:11 +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