index.rst

Welcome to OpenCompass' documentation!
==========================================

Hands-on Roadmap of OpenCompass
-------------------------------

To help users quickly utilize OpenCompass, we recommend following the hands-on
roadmap we have created for the library:

    - For users who want to use OpenCompass, we recommend reading the GetStarted_ section first to set up the environment.

    - For some basic usage, we suggest users read the UserGuides_.

    - If you want to customize the algorithm, we have provided the AdvancedGuides_.

    - If you want to adjust the prompts, you can browse the Prompt_.

    - We also offer the Tools_.

We always welcome *PRs* and *Issues* for the betterment of MMPretrain.

.. _GetStarted:
.. toctree::
   :maxdepth: 1
   :caption: Get Started

   get_started.md

.. _UserGuides:
.. toctree::
   :maxdepth: 1
   :caption: UserGuides

   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

.. _AdvancedGuides:
.. toctree::
   :maxdepth: 1
   :caption: AdvancedGuides

   advanced_guides/new_dataset.md
   advanced_guides/new_model.md

.. _Prompt:
.. toctree::
   :maxdepth: 1
   :caption: Prompt

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

.. _Tools:
.. toctree::
   :maxdepth: 1
   :caption: tools

   tools.md

.. _Notes:
.. toctree::
   :maxdepth: 1
   :caption: Notes

   notes/contribution_guide.md

.. toctree::
   :caption: switch language

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


Indexes & Tables
==================

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