refactor api.md (d2l-ai#1894)

* re-org d2l.md * update api.md
yfliao · Aug 24, 2021 · 63cafb0 · 63cafb0
1 parent fb5637e
commit 63cafb0
Show file tree

Hide file tree

Showing 4 changed files with 1,639 additions and 1,853 deletions.
diff --git a/chapter_appendix-tools-for-deep-learning/d2l.md b/chapter_appendix-tools-for-deep-learning/d2l.md
@@ -8,9 +8,7 @@ The implementations of the following members of the `d2l` package and sections w
 
 ```eval_rst
 
-.. automodule:: d2l.mxnet
-   :members:
-   :imported-members:
+.. currentmodule:: d2l.mxnet
 
 ```
 
@@ -20,23 +18,81 @@ The implementations of the following members of the `d2l` package and sections w
 
 ```eval_rst
 
-.. automodule:: d2l.torch
-   :members:
-   :imported-members:
+.. currentmodule:: d2l.torch
+
+```
+
+:begin_tab:`tensorflow`
+
+```eval_rst
+
+.. currentmodule:: d2l.torch
 
 ```
 
 :end_tab:
 
+## Models
 
-:begin_tab:`tensorflow`
+```eval_rst 
 
-```eval_rst
+.. autoclass:: Module
+   :members: 
 
-.. automodule:: d2l.tensorflow
+.. autoclass:: LinearRegressionScratch
+   :members:
+
+.. autoclass:: LinearRegression
+   :members:    
+
+.. autoclass:: Classification
    :members:
-   :imported-members:
 
 ```
 
-:end_tab:
+## Data
+
+```eval_rst 
+
+.. autoclass:: DataModule
+   :members: 
+
+.. autoclass:: SyntheticRegressionData
+   :members: 
+
+.. autoclass:: FashionMNIST
+   :members: 
+
+```
+
+## Trainer
+
+```eval_rst 
+
+.. autoclass:: Trainer
+   :members: 
+
+.. autoclass:: SGD
+   :members: 
+
+```
+
+## Utilities
+
+```eval_rst 
+
+.. autofunction:: add_to_class
+
+.. autofunction:: cpu
+
+.. autofunction:: gpu
+
+.. autofunction:: num_gpus
+
+.. autoclass:: ProgressBoard
+   :members: 
+
+.. autoclass:: HyperParameters
+   :members:    
+
+```