History

Yang Wang 210677a295 Add nano documentation for pytorch training quickstart (#4577 ) * Add nano documentation for pytorch training quickstart * fix some typo * break pytorch training and inference to two files * simplify trainer import * fix train doc		2022-05-16 14:14:30 +08:00
..
_build	add docs	2021-10-12 11:06:44 +08:00
image	[PPML]Update the document of graphene (#4500 )	2022-04-26 14:04:15 +08:00
source	Add nano documentation for pytorch training quickstart (#4577 )	2022-05-16 14:14:30 +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	add docs	2021-10-12 11:06:44 +08:00
requirements-doc.txt	remove tsfresh to solve doc building conflict for protobuf version (#4047 )	2022-02-16 15:49:09 +08:00
requirements-rtd.txt	add docs	2021-10-12 11:06:44 +08:00

README.md

Analytics-zoo-doc 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