index.rst

欢迎来到 OpenCompass 中文教程！
==========================================

OpenCompass 上手路线
-------------------------------

为了用户能够快速上手，我们推荐以下流程：

   - 对于想要使用 OpenCompass 的用户，我们推荐先阅读 开始你的第一步_ 部分来设置环境。

   - 对于一些基础使用，我们建议用户阅读 教程_ 。

   - 若您想进行算法的自定义，我们提供了 进阶教程_ 。

   - 如果您想调整提示语，您可以浏览 提示语_ 。

   - 我们同样提供了 工具_ 。


我们始终非常欢迎用户的 PRs 和 Issues 来完善 OpenCompass！

.. _开始你的第一步:
.. toctree::
   :maxdepth: 1
   :caption: 开始你的第一步

   get_started.md

.. _教程:
.. toctree::
   :maxdepth: 1
   :caption: 教程

   user_guides/framework_overview.md
   user_guides/config.md
   user_guides/dataset_prepare.md
   user_guides/models.md
   user_guides/evaluation.md
   user_guides/experimentation.md
   user_guides/metrics.md

.. _进阶教程:
.. toctree::
   :maxdepth: 1
   :caption: 进阶教程

   advanced_guides/new_dataset.md
   advanced_guides/new_model.md

.. _提示语:
.. toctree::
   :maxdepth: 1
   :caption: 提示语

   prompt/overview.md
   prompt/few_shot.md
   prompt/prompt_template.md
   prompt/meta_template.md

.. _工具:
.. toctree::
   :maxdepth: 1
   :caption: 工具

   tools.md

.. _其他说明:
.. toctree::
   :maxdepth: 1
   :caption: 其他说明

   notes/contribution_guide.md

.. toctree::
   :caption: 切换语言

   English <https://mmpretrain.readthedocs.io/en/latest/>
   简体中文 <https://mmpretrain.readthedocs.io/zh_CN/latest/>


索引与表格
==================

* :ref:`genindex`
* :ref:`search`