Commit graph

49 commits

Author SHA1 Message Date
SONG Ge
f2950e55a2 add notes for python version issue in databricks tutorial (#7730) 2023-03-02 09:38:58 +08:00
Kai Huang
d961fdee59 Remove 246/312/313 from script names (#7593)
* remove 246

* remove 313

* fix pandas version
2023-02-17 14:44:23 +08:00
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
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
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
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
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
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
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
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
Jian Zhou
936f8d2adb update databricks doc (#6035)
Co-authored-by: Zhou <jian.zhou@intel.com>
2022-09-30 17:03:30 +08:00
Jian Zhou
a703ae4eba Update Databricks user guide (#5920)
* update databricks doc

* update databricks doc

* update databricks doc

* update databricks doc

* update databricks doc

* update databricks doc

Co-authored-by: Zhou <jian.zhou@intel.com>
2022-09-28 09:47:18 +08:00
SONG Ge
79f29244d8 [Orca] Add bigdl-submit mode support (#5960)
* add bigdl-submit mode support

* modify all submit-with-bigdl

* remove submit-with-bigdl info
2022-09-27 15:17:41 +08:00
pinggao187
0cabc79133 change spark313 to spark312 (#5956) 2022-09-26 15:18:54 +08:00
pinggao187
0af2711dbf update pypi/spark version (#5925) 2022-09-23 14:30:49 +08:00
Jian Zhou
5c453157de update Databricks user guide (#5779)
* update databricks doc

* update databricks doc

* update databricks doc

* update databricks doc

* update databricks doc

* update databricks doc

Co-authored-by: Zhou <jian.zhou@intel.com>
2022-09-16 10:31:55 +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
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
Kai Huang
70b2070e4d Update Python User Guide (#5275)
* add doc

* fix
2022-08-02 12:24:52 +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
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
Le-Zheng
db2818c8f7 update databrciks doc (#4691) 2022-05-26 07:41:44 +08:00
Le-Zheng
56aee11c82 fix version in docs (k8s/scala) (#4440)
* fix version in docs (k8s/scala)

* update
2022-04-18 16:26:44 -07:00
Kai Huang
0c0e99fee5 Fix spark-submit scripts and doc (#4344)
* fix yarn client

* fix shell script

* revert sh

* revert

* update doc

* finish doc update

* fix

* minor
2022-04-06 19:27:43 +08:00
Le-Zheng
e971385798 update docker version to 2.1.0-SNAPSHOT in docs (#4150) 2022-03-01 18:37:53 -08:00
Xin Qiu
193a063504 update Scala doc (#4055)
* Update develop.md

* update scala/pom.xml
2022-02-18 10:38:24 +08:00
Kai Huang
2f39947b16 Update Python Develop Guide (#4054)
* fix docs

* update

* update

* update

* update

* update
2022-02-17 15:06:31 +08:00
Le-Zheng
7f172c4df2 docker image jupyter (#3938)
> Is this PR tested and ready for merge?
yes
2022-02-16 01:05:52 -08:00
Shan Yu
ce7a812623 Upgrade Ray version to 1.9.2 in documents and setup (#4037)
* upgrade ray 1.2.0 to 1.9.2 in documents

* change ray version 1.9.0 to 1.9.2 in setup
2022-02-16 12:21:58 +08:00
Le-Zheng
a3a202e335 Update k8s doc (#3999) 2022-02-10 23:41:43 -08:00
Kai Huang
77d32ba140 Add bigdl-spark3 in doc (#3932)
* add spark3

* minor
2022-01-24 15:22:12 +08:00
Le-Zheng
e5d2004933 hotfix k8s doc (#3718) 2021-12-14 09:55:52 +08:00
Le-Zheng
18d5e6a7a0 Update docker.md 2021-12-09 13:49:13 +08:00
Le-Zheng
1951149792 update docker use guide readthedocs (#3628) 2021-12-01 09:13:37 +08:00
helenlly
181e086cff update Python User Guide and Scala User Guide with supported platforms info (#3593)
* Update python.md

* Update scala.md

* Update python.md

* Update scala.md

* Update python.md

* Update scala.md

* Update python.md

* Update scala.md

* Update python.md

* Update python.md

* Update scala.md
2021-11-30 09:30:48 +08:00
Kai Huang
dffeda5e1e Update k8s user guide for run from remote (#3606)
* update doc

* minor

* update

* fix

* minor

* minor

* fix
2021-11-26 17:54:13 +08:00
Xin Qiu
ee95ab6198 revert 3366 (#3547) 2021-11-23 13:23:46 +08:00
Le-Zheng
bee5879b24 update k8s docs (#3461) 2021-11-19 17:17:05 +08:00
Le-Zheng
238a434950 Update colab notebooks (#3486) 2021-11-16 17:16:11 +08:00
Le-Zheng
4c5a0b9729 BigDL2.0 colab user guide (#3225)
* BigDL2.0 colab user guide
2021-11-15 14:05:29 +08:00
Xin Qiu
453c991c19 Update hadoop.md (#3433)
* Update hadoop.md

* Update hadoop.md

* Update hadoop.md

* add pyspark with dllib

* some update

* add spark-submit-with-dllib

* Update hadoop.md

* Update hadoop.md

* Update hadoop.md

* Update hadoop.md

* Update hadoop.md

* Update hadoop.md

* Update hadoop.md

* Update hadoop.md

* Update hadoop.md
2021-11-12 13:34:04 +08:00
dding3
2202949eac integrate dllib.md with scala.md (#3388)
* integrate dllib.md with scala.md

* add how to run in cluster for python dllib
2021-11-04 20:22:58 +08:00
Xin Qiu
17060f541a change engine's required configuration to warning (#3366)
* change engine's error to warning

* delete spark.shuffle.reduceLocality.enabled

* Update test_spark-bigdl.conf

* Update EngineSpec.scala

* Update test_zoo_utils.py

* Update test_image3d.py

* Update AnalyticsZoo-on-Databricks.md

* Update databricks.md

* Update test_zoo_utils.py
2021-11-03 09:35:37 +08:00
Yu Shan
ebc58fa419 Change Analytics Zoo to BigDL in python user guide (#3255)
* change analytics zoo to bigdl

* remove version check since we haven't support it yet

* add pip uninstall
2021-10-27 14:27:28 +08:00
Xin Qiu
a3dc9a0158 Update scala docs (#3248)
* Update scala.md

* Update scala.md

* Update scala.md

* Update scala.md

* Update scala.md

* Update scala.md
2021-10-26 09:16:22 +08:00
Xin Qiu
3c316e0071 update hadoop/yarn user guide (#3249)
* Update hadoop.md

* Update hadoop.md

* Update hadoop.md

* Update hadoop.md

* Update hadoop.md
2021-10-26 09:15:46 +08:00
jenniew
71838b1977 [BigDL-2.0] Update Databricks documents (#4956)
* upate doc

* update
2021-10-14 15:42:33 -07:00
gaoping
21543a05ed add docs 2021-10-12 11:06:44 +08:00