ipex-llm/docs/readthedocs
Yuwen Hu 12c12a1058 [Nano] How-To Guides: Training - PyTorch Lightning (#5643)
* Rearrange file structure for PyTorch Inference for docs and add titles for PyTorch-Lightning Training

* Add How-to guide: How to accelerate a PyTorch-Lightning application on training workloads through Intel® Extension for PyTorch*

* Add how-to guide: How to accelerate a PyTorch-Lightning application on training workloads through multiple instances

* Revise: remove '-' in 'PyTorch-Lightning' and some other changes

* Add How-to guides: How to use the channels last memory format in your PyTorch Lightning application for training

* Add how-to guide: Use BFloat16 Mixed Precision for PyTorch Lightning Training

* Add How-to guide: How to accelerate a computer vision data processing pipeline

* Small Revision: change comments in several code cells

* Disable other nano tests temporarily

* Add github action tests for Nano Training PyTorch Lightning tests

* Enable other nano tests again

* Small revisions: typos and explanation texts changes

* Revise: update based on comments
2022-09-15 15:26:11 +08:00
..
_build add docs 2021-10-12 11:06:44 +08:00
image Update Azure PPML docs (#5163) 2022-07-25 12:59:34 -07:00
source [Nano] How-To Guides: Training - PyTorch Lightning (#5643) 2022-09-15 15:26:11 +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 Add ipython extension for rendering code blocks in excuted notebooks properly in our readthedocs project (#5757) 2022-09-14 17:25:55 +08:00
requirements-rtd.txt Readthedoc: update requirements version in doc (#5181) 2022-07-25 10:09:18 +08:00

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