add models docs (mindspore-lab#166)

Geaming2002 · Dec 24, 2022 · a324b29 · a324b29
1 parent b8dc119
commit a324b29
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 31 deletions.
diff --git a/README.md b/README.md
@@ -39,22 +39,23 @@ The master branch works with **MindSpore master**.
 
 ## Quick Links
 
-- [Website](https://mindnlp.cqu.ai/en/latest/)
+- [Documentation](https://mindnlp.cqu.ai/en/latest/)
 - [Examples](https://github.com/mindspore-ecosystem/mindnlp/tree/master/examples)
 - ...
 
 ## Installation
 
 ### Dependency
 
-- mindspore >= ...
-- ...
+- mindspore >= 1.8.1
 
 ### Install from source
 
 To install MindNLP from source, please run:
 
-`pip install git+https://github.com/mindspore-ecosystem/mindnlp.git`
+```bash
+pip install git+https://github.com/mindspore-ecosystem/mindnlp.git
+```
 
 ## Get Started
 
@@ -169,19 +170,19 @@ trainer.run(tgt_columns="label", jit=False)
 print("end train")
 ```
 
-## Tutorials
+<!-- ## Tutorials
 
-- (list of more tutorials...)
+- (list of more tutorials...) -->
 
-## Notes
+<!-- ## Notes -->
 
 ### License
 
 This project is released under the [Apache 2.0 license](LICENSE).
 
 ### Feedbacks and Contact
 
-The dynamic version is still under development, if you find any issue or have an idea on new features, please don't hesitate to contact us via [Gitee Issues](https://gitee.com/mindspore/text/issues).
+The dynamic version is still under development, if you find any issue or have an idea on new features, please don't hesitate to contact us via [Github Issues](https://github.com/mindspore-lab/mindnlp/issues).
 
 ### Acknowledgement
 

diff --git a/docs/api/models.rst b/docs/api/models.rst
@@ -1,4 +1,4 @@
-models
+Models
 ======================
 
 
@@ -9,25 +9,3 @@ bert
    :members:
    :undoc-members:
    :show-inheritance:
-
-elmo
---------------------------
-
-.. automodule:: mindnlp.models.elmo
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-gpt
--------------------------
-
-.. automodule:: mindnlp.models.gpt
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-
-.. automodule:: mindnlp.models
-   :members:
-   :undoc-members:
-   :show-inheritance:
diff --git a/docs/index.rst b/docs/index.rst
@@ -45,4 +45,5 @@ What is MindNLP
    api/dataset
    api/engine
    api/modules
+   api/models
    api/utils
diff --git a/docs/overview/prerequisites.rst b/docs/overview/prerequisites.rst
@@ -1,2 +1,18 @@
 Prerequisites
 ===================
+
+Install MindNLP
+----------------
+
+.. code-block::
+
+    pip install mindnlp
+
+Install from source code
+------------------------
+
+.. code-block::
+
+    pip install git+https://github.com/mindspore-lab/mindnlp
+
+