目录
==========================

.. toctree::
   :glob:
   :maxdepth: 1
   :caption: 开始

   Introduction.md
   docs/model_support_list.md


.. toctree::
   :glob:
   :maxdepth: 1
   :caption: 安装

   Version_Match.md
   Install.md


.. toctree::
   :glob:
   :maxdepth: 1
   :caption: 设计

   docs/design/AutoClass_Design.md
   docs/design/Trainer_Design.md
   docs/design/Pipeline_Design.md
   docs/design/Config_Design.md
   docs/design/Parallel_Design.md
   docs/design/Pet_Tuners_Design.md


.. toctree::
   :glob:
   :maxdepth: 1
   :caption: 快速入门

   Quick_Tour.md


.. toctree::
   :glob:
   :maxdepth: 2
   :caption: 模型&任务

   docs/model_cards/index
   docs/task_cards/index


.. toctree::
   :glob:
   :maxdepth: 1
   :caption: 特性使用指南

   docs/feature_cards/LLM_DataLoader.md
   docs/feature_cards/Training_Algorithms.md
   docs/feature_cards/Resume_Training.md
   docs/feature_cards/Pet_Tuners.md
   docs/feature_cards/Auto_Parallel.md
   docs/feature_cards/Eval_While_Training.md
   docs/feature_cards/Transform_Ckpt.md
   docs/feature_cards/Text_Generator.md
   docs/feature_cards/Inference.md
   docs/feature_cards/Chat_Web.md
   docs/feature_cards/Dynamic_Cluster.md

.. toctree::
   :glob:
   :maxdepth: 1
   :caption: 调试调优

   docs/Debugging_Tuning/Precision_Optimization.md
   docs/Debugging_Tuning/Performance_Tuning.md


.. toctree::
   :glob:
   :maxdepth: 1
   :caption: 最佳实践

   docs/practice/Using_Api.md
   docs/practice/Develop_With_Api.md
   docs/practice/AICC.md
   docs/practice/gpt2_example.md
   docs/practice/llama_example.md
   docs/practice/Environment.md

.. toctree::
   :glob:
   :maxdepth: 1
   :caption: API

   docs/api_python/README.md
   docs/api_python/mindformers
   docs/api_python/mindformers.core
   docs/api_python/mindformers.dataset
   docs/api_python/mindformers.generation
   docs/api_python/mindformers.models
   docs/api_python/mindformers.modules
   docs/api_python/mindformers.pet
   docs/api_python/mindformers.pipeline
   docs/api_python/mindformers.trainer
   docs/api_python/mindformers.wrapper


.. toctree::
   :glob:
   :maxdepth: 1
   :caption: FAQ

   docs/FAQ.md
   docs/transformer仓Python编程规范.md


.. toctree::
   :glob:
   :maxdepth: 1
   :caption: RELEASE NOTE

   docs/RELEASE_NOTE.md