From 20ad708010dbe67ff9e2f7527d980950e3fe71e8 Mon Sep 17 00:00:00 2001
From: Yang Wang <yang3.wang@intel.com>
Date: Wed, 8 Jun 2022 17:45:24 +0800
Subject: [PATCH] Add  Nano PyTorch API Doc (#4730)

* add trainer api doc

* add index and fix trainer

* fix doc

* reset

* fix conflict

* fix import
---
 docs/readthedocs/requirements-doc.txt                  |  5 +++--
 docs/readthedocs/source/conf.py                        |  3 +++
 docs/readthedocs/source/doc/PythonAPI/Nano/index.rst   |  7 +++++++
 docs/readthedocs/source/doc/PythonAPI/Nano/pytorch.rst | 10 ++++++++++
 docs/readthedocs/source/index.rst                      |  1 +
 5 files changed, 24 insertions(+), 2 deletions(-)
 create mode 100644 docs/readthedocs/source/doc/PythonAPI/Nano/index.rst
 create mode 100644 docs/readthedocs/source/doc/PythonAPI/Nano/pytorch.rst

diff --git a/docs/readthedocs/requirements-doc.txt b/docs/readthedocs/requirements-doc.txt
index 7e860383..d992bb29 100644
--- a/docs/readthedocs/requirements-doc.txt
+++ b/docs/readthedocs/requirements-doc.txt
@@ -6,9 +6,10 @@ sphinxemoji
 click
 tensorflow==1.15.2
 bigdl==0.12.0
+cloudpickle
 ray[tune]==1.9.2
 ray==1.9.2
-torch==1.7.1
+torch==1.9.0
 Pygments==2.3.1
 setuptools==41.0.1
 docutils==0.14
@@ -27,6 +28,6 @@ pmdarima
 sphinx_markdown_tables
 numpy==1.21.2
 xgboost
-torchmetrics
+torchmetrics==0.7.2
 pickle5==0.0.12
 protobuf~=3.19.0
\ No newline at end of file
diff --git a/docs/readthedocs/source/conf.py b/docs/readthedocs/source/conf.py
index ff627567..0991e694 100644
--- a/docs/readthedocs/source/conf.py
+++ b/docs/readthedocs/source/conf.py
@@ -18,6 +18,8 @@ import glob
 import shutil
 import urllib
 
+autodoc_mock_imports = ["openvino", "pytorch_lightning"]
+
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #sys.path.insert(0, '.')
 sys.path.insert(0, os.path.abspath('.'))
@@ -26,6 +28,7 @@ sys.path.insert(0, os.path.abspath("../../../python/chronos/src/"))
 sys.path.insert(0, os.path.abspath("../../../python/dllib/src/"))
 sys.path.insert(0, os.path.abspath("../../../python/orca/src/"))
 sys.path.insert(0, os.path.abspath("../../../python/serving/src/"))
+sys.path.insert(0, os.path.abspath("../../../python/nano/src/"))
 
 
 
diff --git a/docs/readthedocs/source/doc/PythonAPI/Nano/index.rst b/docs/readthedocs/source/doc/PythonAPI/Nano/index.rst
new file mode 100644
index 00000000..35565cba
--- /dev/null
+++ b/docs/readthedocs/source/doc/PythonAPI/Nano/index.rst
@@ -0,0 +1,7 @@
+Nano API
+==================
+
+.. toctree::
+    :maxdepth: 2
+
+    pytorch.rst
diff --git a/docs/readthedocs/source/doc/PythonAPI/Nano/pytorch.rst b/docs/readthedocs/source/doc/PythonAPI/Nano/pytorch.rst
new file mode 100644
index 00000000..e5552362
--- /dev/null
+++ b/docs/readthedocs/source/doc/PythonAPI/Nano/pytorch.rst
@@ -0,0 +1,10 @@
+Nano PyTorch API
+==================
+
+bigdl.nano.pytorch
+---------------------------
+
+.. autoclass:: bigdl.nano.pytorch.Trainer
+    :members:
+    :undoc-members:
+    :exclude-members: accelerator_connector, checkpoint_connector, reload_dataloaders_every_n_epochs, limit_val_batches, logger, logger_connector, state
diff --git a/docs/readthedocs/source/index.rst b/docs/readthedocs/source/index.rst
index 4e9d0268..8ab72034 100644
--- a/docs/readthedocs/source/index.rst
+++ b/docs/readthedocs/source/index.rst
@@ -125,6 +125,7 @@ BigDL Documentation
    doc/PythonAPI/Orca/orca.rst
    doc/PythonAPI/Friesian/feature.rst
    doc/PythonAPI/Chronos/index.rst
+   doc/PythonAPI/Nano/index.rst
 
 .. toctree::
    :maxdepth: 1