use mkdocs to generate documentation (#1070)

mindspore-lab · May 13, 2024 · 2a4e534 · 2a4e534
1 parent e0ebe50
commit 2a4e534
Show file tree

Hide file tree

Showing 122 changed files with 326 additions and 11,851 deletions.
diff --git a/.gitignore b/.gitignore
@@ -156,4 +156,5 @@ RuntimeProfiler*
 checkpoint-*/
 data*/
 !mindnlp/data/
-!mindnlp/dataset/
+!mindnlp/dataset/
+!docs/api/data/
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -1,5 +1,4 @@
-# .readthedocs.yaml
-# Read the Docs configuration file
+# Read the Docs configuration file for MkDocs projects
 # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
 
 # Required
@@ -9,21 +8,12 @@ version: 2
 build:
   os: ubuntu-22.04
   tools:
-    python: "3.7"
-    # You can also specify other tool versions:
-    # nodejs: "19"
-    # rust: "1.64"
-    # golang: "1.19"
+    python: "3.12"
 
-# Build documentation in the docs/ directory with Sphinx
-sphinx:
-   configuration: docs/conf.py
+mkdocs:
+  configuration: mkdocs.yml
 
-# If using Sphinx, optionally build your docs in additional formats such as PDF
-# formats:
-#    - pdf
-
-# Optionally declare the Python requirements required to build your docs.
+# Optionally declare the Python requirements required to build your docs
 python:
    install:
-   - requirements: requirements/docs_requirements.txt
+   - requirements: requirements/docs_requirements.txt
diff --git a/README.md b/README.md
@@ -18,19 +18,16 @@
     </a>
 </p>
 
-[Installation](#installation) |
-[Introduction](#introduction) |
-[Quick Links](#quick-links) |
 
 ### News 📢
 
 * 🔥 **Latest Features**
 
   * 🤗 Hugging *huggingface* ecosystem, we use **datasets** lib as default dataset loader to support
   mounts of useful datasets.
-  * 📝 MindNLP supports NLP tasks such as *language model*, *machine translation*, *question answering*, *sentiment analysis*, *sequence labeling*, *summarization*, etc. You can access them through [examples](./examples/).
-  * 🚀 MindNLP currently supports industry-leading Large Language Models (LLMs), including **Llama**, **GLM**, **RWKV**, etc. For support related to large language models, including ***pre-training***, ***fine-tuning***, and **inference** demo examples, you can find them in the ["llm" directory](./llm/).
-  * 🤗 Pretrained models support ***huggingface transformers-like apis***, including **60+** models like **[BERT](./mindnlp/transformers/models/bert)**, **[Roberta](./mindnlp/transformers/models/roberta)**, **[GPT2](./mindnlp/transformers/models/gpt2)**, **[T5](./mindnlp/transformers/models/t5)**, etc.
+  * 📝 MindNLP supports NLP tasks such as *language model*, *machine translation*, *question answering*, *sentiment analysis*, *sequence labeling*, *summarization*, etc. You can access them through [examples](https://github.com/mindspore-lab/mindnlp/examples/).
+  * 🚀 MindNLP currently supports industry-leading Large Language Models (LLMs), including **Llama**, **GLM**, **RWKV**, etc. For support related to large language models, including ***pre-training***, ***fine-tuning***, and **inference** demo examples, you can find them in the ["llm" directory](https://github.com/mindspore-lab/mindnlp/llm/).
+  * 🤗 Pretrained models support ***huggingface transformers-like apis***, including **60+** models like **[BERT](https://github.com/mindspore-lab/mindnlp/mindnlp/transformers/models/bert)**, **[Roberta](https://github.com/mindspore-lab/mindnlp/mindnlp/transformers/models/roberta)**, **[GPT2](https://github.com/mindspore-lab/mindnlp/mindnlp/transformers/models/gpt2)**, **[T5](https://github.com/mindspore-lab/mindnlp/mindnlp/transformers/models/t5)**, etc.
     You can use them easily by following code snippet:
     ```python
     from mindnlp.transformers import AutoModel
@@ -84,18 +81,10 @@ The master branch works with **MindSpore master**.
 - **Friendly NLP model toolset**: MindNLP provides various configurable components. It is friendly to customize models using MindNLP.
 - **Easy-to-use engine**: MindNLP simplified complicated training process in MindSpore. It supports Trainer and Evaluator interfaces to train and evaluate models easily.
 
-### Quick Links
-
-- [Documentation](https://mindnlp.cqu.ai/en/latest/)
-- [Tutorials](./tutorials/)
-- [Examples](./examples)
-- [LLMs](./llm)
-- ...
-
 
 ### Supported models
 
-Since there are too many supported models, please check [here](./SUPPORT_MODEL.md)
+Since there are too many supported models, please check [here](https://mindnlp.cqu.ai/supported_models)
 
 <!-- ## Tutorials
 
@@ -124,7 +113,7 @@ If you find this project useful in your research, please consider citing:
 
 ```latex
 @misc{mindnlp2022,
-    title={{MindNLP}: a MindSpore NLP library},
+    title={{MindNLP}: Easy-to-use and high-performance NLP and LLM framework based on MindSpore},
     author={MindNLP Contributors},
     howpublished = {\url{https://github.com/mindlab-ai/mindnlp}},
     year={2022}

diff --git a/docs/Makefile b/docs/Makefile
diff --git a/docs/api/abc.rst b/docs/api/abc.rst
diff --git a/docs/api/dataset.rst b/docs/api/dataset.rst
diff --git a/docs/api/dataset/hf_datasets.rst b/docs/api/dataset/hf_datasets.rst
diff --git a/docs/api/dataset/machine_translation.rst b/docs/api/dataset/machine_translation.rst
diff --git a/docs/api/dataset/question_answer.rst b/docs/api/dataset/question_answer.rst
diff --git a/docs/api/dataset/registered.rst b/docs/api/dataset/registered.rst
diff --git a/docs/api/dataset/sequence_tagging.rst b/docs/api/dataset/sequence_tagging.rst