Commit graph

287 commits

Author SHA1 Message Date
Cengguang Zhang
1453e5c244 Doc: Update orca hadoop user guide. (#6574)
* fix: update log filepath and branch.

* feat: update user guide.

* fix: update hadoop user guide

* fix: update hadoop user guide
2022-11-14 09:35:39 +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
Kai Huang
9c99751288 Update Orca 5min (#6524) 2022-11-10 10:57:19 +08:00
Kai Huang
7da102243e Update Orca install doc (#6518)
* update install

* update

* update

* update link

* update 5min

* update 5mins

* update link
2022-11-10 10:28:46 +08:00
Qiyuan Gong
17fb75f8d7 [PPML] Refine readthedoc lines and space (#6509)
* Remove empty lines
* Use same space for indent
* Add empty line at the end
2022-11-09 13:41:21 +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
Qiyuan Gong
a46618844f [PPML] Add mermaid to deployment and installation doc (#6497)
* Fix deployment doc mermaid.
* Add PCCS network to installation doc.
2022-11-09 08:57:17 +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
Kai Huang
1e7681325b Update yarn tutorial (#6456)
* update yarn tutorial

* style

* update

* revert

* minor
2022-11-07 13:58:58 +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
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
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
liangs6212
29e9c18c70 Chronos: Make known issue page more friendly (#6321)
* make known issues more friendly

* resettitle size

* add new line

* fix style

* fix style again

* fix style again

* fix known issues
2022-11-04 14:43:50 +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
Jiao Wang
85445fdd39 add support for acr (#6440) 2022-11-03 19:09:16 -07:00
Junwei Deng
654baef1a3 Nano: refactor inference optimizer code for better code reuse (#6330)
* add base optimizer for future InferenceOptimizer keras

* fix type

* add type change

* change doc
2022-11-02 11:07:57 +08:00
Qiyuan Gong
c9b06eb431 [PPML] Add MP Auto and warning (#6395)
* Add MP Auto in BIOS
* Add warning for installation from binary
2022-11-02 09:07:30 +08:00
Jiao Wang
4dac556c68 [PPML] Update documentation of PPML Occlum on Azure (#6372)
* update with Azure Marketplace

* update

* update
2022-10-31 18:59:07 -07:00
Junwei Deng
2629bb0645 Chronos: fix the installation guide link (#6322) 2022-10-31 17:27:38 +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
Xiangyu Tian
df3c04199f Add BigDL-PPML-Azure-Occlum-Example to readthedocs (#6292)
* Init

* Refine

* Refine

* Fix
2022-10-27 16:50:34 +08:00
Xin Qiu
aea43b44d4 update VFL HE document (#6262)
* Create vfl_he

* Rename vfl_he to vfl_he.md

* upload fl_ckks.PNG

* Update vfl_he.md

* Update vfl_he.md

* Update overview.md
2022-10-26 08:23:12 +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
Juntao_Luo
39bd960e2a Bugfix: fix chronos installation panel cmd line overflow. (#6276) 2022-10-25 14:16:08 +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
b4d01ac706 Update Orca install guide (#6268)
* update install

* fix link

* minor
2022-10-24 18:49:12 +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
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
Yuwen Hu
f5ef76acf3 [Doc] Add collapsing functionality to the quicklink titles in landing page (#6225)
* Make sidebar titles in landing page collapsed

* Remove 'Slow PyTorch training with BF16' section in windows user guide
2022-10-24 10:52:47 +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
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
Kai Huang
f98a8612c6 Add YARN tutorial to docs (#6242)
* add yarn to docs

* modify

* meet review

* modify style

* minor

* change #

* minor
2022-10-21 17:08:16 +08:00
CharleneHu94
5e4c269a49 [PPML] TPC-DS doc upadte (#6238)
* ppml tpcds doc update

* fix

* update data generation step
2022-10-21 17:01:37 +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
Qiyuan Gong
d36e7c4ff3 [PPML] Add BIOS conf & 1 known issues for installing SGX driver (#6206)
* Add BIOS configuration. 
* Add memory check for SGX, i.e., `Installed Memory = Total Memory + 2 * PRMRR`.
* Add BTF issues for installing SGX driver.
* Refine 2 known issue solutions.
2022-10-20 09:05:26 +08:00
Yuwen Hu
65cb3720f5 [Doc] Revise tooltips on decision tree and small fixes (#6197)
* Revise tooltips of decision tree

* Small list indent problem fix
2022-10-19 15:45:39 +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
Junwei Deng
6a7ab76a8e Nano: add a patch_torch/patch_tensorflow API for friendly usage (#5946)
* add a prototype code

* add patch_nano

* add pep8 changes

* add cv ppl

* fix bug

* add unpatch

* add updates

* update comment

* add changes

* add doc

* update and refactor

* update test

* fix doc

* fix according to cmt

* fix style

* fix doc

* fix bug

* fix style

* fix bug

* fix code

* add split patching api

* fix doc

* patch api to each framework

* fix pep8

* fix style

* fix style and cmt
2022-10-19 14:29:24 +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
pinggao187
8e0d589845 update spark3.1.2 to spark3.1.3 (#6154)
* update spark3.1.2 to spark3.1.3

* uodate
2022-10-18 15:35:08 +08:00
Jiao Wang
e28edad625 [PPML] Azure PPML on graphene update (#6041)
* fix scripts and docs

* update

* add simple query to examples

* update

* update script

* update

* update

* update

* update

* update

* update
2022-10-17 18:43:23 -07:00
Guoqiong Song
8ea2907647 dllib doc fix (#6147) 2022-10-17 17:18:53 -07:00
joan726
daf86e9747 Update blogs.md (#6111) 2022-10-14 15:27:06 +08:00
binbin Deng
bde2f0930a Chronos: change import path of get_public_dataset (#6075)
* first commit

* fix
2022-10-14 09:58:38 +08:00
Hu, Zhaojie
4d56ece258 [Chronos] Add install options in chronos-nightly docker image (#6064)
* add install options for chronos dockerfile

* add invaild argument check

* add arg num check & add extra_dep arg

* remove debug message

* add build args message in README & change arg num check message

* add ml option in arg model

* add default value for each build arg

* update readme and howto guides

* fix typo

* fix typo

* fix markdown

* fix markdown
2022-10-13 22:20:28 +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