Commit graph

42 commits

Author SHA1 Message Date
Ruonan Wang
100f2df428 update doc (#6261) 2022-10-24 14:55:23 +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
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
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
Junwei Deng
28acefdb7c Chronos: update installation guide to reflect our work on better tensorflow support (#6066) 2022-10-10 17:31:02 +08:00
Ruonan Wang
f3c8ae37f1 Chronos : How to generate confidence interval for prediction (#5817)
* first commit

* fix version conflict in colab

* update based on comment

* change val_data to validation_data

* remove exit()
2022-09-28 14:34:20 +08:00
Ruonan Wang
13e3137cfd Fix a bug of readthedocs about get_public_dataset (#5808) 2022-09-19 09:12:25 +08:00
binbin Deng
88faa59eb4 Chronos: how to evaluate using forecaster (#5710) 2022-09-16 09:06:27 +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
David smurf
c73fc9f6ad Chronos: train tcn model on gpu and speed up inference on cpu (#5594)
* add nano_gpu

* simplify the code

* simplify the code

* modify the code

* add some updates

* add document

Co-authored-by: theaperdeng <theaperdeng@outlook.com>
2022-09-09 13:07:22 +08:00
binbin Deng
103546d8fe Chronos: how to speedup inference on one node (onnx, openvino) (#5556)
* how to speedup inference on one node

* index added

* fixed

* fixed

* split to 2 guides

* add build_onnx and build_openvino

* add note border

* fix

* fix colab conflict

Co-authored-by: binbin <binbin1.deng@intel.com>
2022-09-07 17:53:38 +08:00
liangs6212
46b0fda3ca Chronos: how to create a forecaster (#5172)
* how to guide from_tsdataset

* improve md

* remove redundant message

* fix known issues

* add rst

* move create-forecaster to new line

* fix known issue

* fix syntax error

* fix syntax error again

* add open-colab icon

* fix known issues

* fix some words

* fix typo

* fix syntax error

* add some update

Co-authored-by: theaperdeng <theaperdeng@outlook.com>
2022-09-07 14:44:06 +08:00
binbin Deng
01ec6107f8 Chronos: make roll=True the default value for to_torch_data_loader (#5605) 2022-09-06 09:28:03 +08:00
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
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
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
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
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
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
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
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
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
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
Shan Yu
5bc293b9c5 Update Chronos installation guide (#4698) 2022-05-26 10:20:33 +08:00
Rebekk
cc2499aa44 Chronos: add chronos known issue (#4496)
* add chronos known issue

* modify doc

* modify chronos_known_issue

* modify chronos issue

* modify

* modify issue

* modify chronos_known_issus
2022-05-13 15:11:31 +08:00
Junwei Deng
ada7b4b978 Chronos: document regular update (#4241)
* add information changes

* update typos

* add typo changes

* update documents

* update chronos.md

* add updates

* fix rst

* add speed-up md

* fix broken links and typos, add tutorials
2022-04-24 15:55:23 +08:00
liangs6212
077cc9f979 Chronos: Sync file paths in doc, branch-2.0-->main (#4091)
* change branch-2.0 to main

* change branch-2.0 to main

* colab and github
2022-03-10 16:00:53 +08:00
Junwei Deng
1375438de3 Chronos: add updated information about models and Nano to document (#4048)
* add updated information about models and Nano

* fix false formate

* add quantization related information

* fix missing quantization api doc

* fix typos
2022-02-17 11:10:12 +08:00
liangs6212
ad47a0b8e0 Chronos: Move use-case to chronos-tutorial and modify page layout (#3868)
* fix chronos deep_dive link error

* add use-case

* delete the use-case contained in chronos.md

* add space

* modify the index.md format

* change page style

* fix link error

* change title link

* fix repo error

* change to relative path

* remove extra symbols

* add \n

* change use-case title

* fix anomaly detection link error
2022-01-13 11:11:40 +08:00
Junwei Deng
625a8f89fe Chronos: Refactor document structure (#3839)
* add strcture change

* add change in index

* add change to index.rst

* revice the document

* add icons

* revise on the pages

* add readme update

* remove ood information

* change title
2022-01-08 16:40:46 +08:00
liangs6212
a0ba173310 Chronos: New built-in dataset (uci_electricity) (#3795)
* add electricity load

* add ut and change doc description

* rename uci_electricity

* rename function
2021-12-28 15:57:29 +08:00
Junwei Deng
ac96d9a35a Chronos: update Chronos quickstart from az to bigdl (#3324)
* fix anomaly detector qs

* fix autoest notebook

* add updates

* add qs name

* update logo

* fix installation guide

* fix typos
2021-10-29 12:59:21 +08:00
Junwei Deng
49af13e215 Chronos: user guide revision/update (#3220)
* add new content to ug of chronos

* add link revise

* fix broken links

* add changes according to comments

* add updates

* fix typos

* change typos
2021-10-28 11:20:14 +08:00
Jason Dai
269b182b04 Update readthedocs (#3165) 2021-10-20 21:51:04 +08:00
gaoping
21543a05ed add docs 2021-10-12 11:06:44 +08:00