History

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
..
_build	add docs	2021-10-12 11:06:44 +08:00
image	change the readthedocs theme and reorg the sections (#6056 )	2022-10-18 15:35:31 +08:00
source	Nano: add a patch_torch/patch_tensorflow API for friendly usage (#5946 )	2022-10-19 14:29:24 +08:00
make.bat	add docs	2021-10-12 11:06:44 +08:00
Makefile	add docs	2021-10-12 11:06:44 +08:00
README.md	Update Readme (#4957 )	2022-06-28 09:27:40 +08:00
requirements-doc.txt	change the readthedocs theme and reorg the sections (#6056 )	2022-10-18 15:35:31 +08:00
requirements-rtd.txt	Readthedoc: update requirements version in doc (#5181 )	2022-07-25 10:09:18 +08:00

README.md

BigDL Documentation

To compile the documentation, run the following commands from this directory.

pip install -r requirements-doc.txt
pip install -U -r requirements-rtd.txt # important for reproducing the deployment environment
make html
open _build/html/index.html

To test if there are any build errors with the documentation, do the following.

sphinx-build -b html -d _build/doctrees source _build/html