2023-07-04 21:34:55 +08:00
|
|
|
Welcome to OpenCompass' documentation!
|
|
|
|
|
==========================================
|
|
|
|
|
|
2023-07-13 09:07:53 +08:00
|
|
|
Getting started with OpenCompass
|
2023-07-04 21:34:55 +08:00
|
|
|
-------------------------------
|
|
|
|
|
|
2023-07-13 09:07:53 +08:00
|
|
|
To help you quickly familiarized with OpenCompass, we recommend you to walk through the following documents in order:
|
2023-07-04 21:34:55 +08:00
|
|
|
|
2023-07-13 09:07:53 +08:00
|
|
|
- First read the GetStarted_ section set up the environment, and run a mini experiment.
|
2023-07-04 21:34:55 +08:00
|
|
|
|
2023-07-13 09:07:53 +08:00
|
|
|
- Then learn its basic usage through the UserGuides_.
|
2023-07-04 21:34:55 +08:00
|
|
|
|
2023-07-13 09:07:53 +08:00
|
|
|
- If you want to tune the prompts, refer to the Prompt_.
|
2023-07-04 21:34:55 +08:00
|
|
|
|
2023-07-13 09:07:53 +08:00
|
|
|
- If you want to customize some modules, like adding a new dataset or model, we have provided the AdvancedGuides_.
|
2023-07-04 21:34:55 +08:00
|
|
|
|
2023-07-13 09:07:53 +08:00
|
|
|
- There are more handy tools, such as prompt viewer and lark bot reporter, all presented in Tools_.
|
2023-07-04 21:34:55 +08:00
|
|
|
|
2023-07-13 09:07:53 +08:00
|
|
|
We always welcome *PRs* and *Issues* for the betterment of OpenCompass.
|
2023-07-04 21:34:55 +08:00
|
|
|
|
|
|
|
|
.. _GetStarted:
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 1
|
|
|
|
|
:caption: Get Started
|
|
|
|
|
|
|
|
|
|
get_started.md
|
|
|
|
|
|
|
|
|
|
.. _UserGuides:
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 1
|
2023-07-06 15:47:09 +08:00
|
|
|
:caption: User Guides
|
2023-07-04 21:34:55 +08:00
|
|
|
|
|
|
|
|
user_guides/config.md
|
2023-07-13 09:07:53 +08:00
|
|
|
user_guides/datasets.md
|
2023-07-04 21:34:55 +08:00
|
|
|
user_guides/models.md
|
|
|
|
|
user_guides/evaluation.md
|
|
|
|
|
user_guides/experimentation.md
|
2023-08-01 11:47:04 +08:00
|
|
|
user_guides/metrics.md
|
2023-07-04 21:34:55 +08:00
|
|
|
|
|
|
|
|
.. _AdvancedGuides:
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 1
|
2023-07-06 15:47:09 +08:00
|
|
|
:caption: Advanced Guides
|
2023-07-04 21:34:55 +08:00
|
|
|
|
|
|
|
|
advanced_guides/new_dataset.md
|
|
|
|
|
advanced_guides/new_model.md
|
|
|
|
|
|
|
|
|
|
.. _Prompt:
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 1
|
|
|
|
|
:caption: Prompt
|
|
|
|
|
|
|
|
|
|
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
|
|
|
|
|
|
|
|
|
|
Indexes & Tables
|
|
|
|
|
==================
|
|
|
|
|
|
|
|
|
|
* :ref:`genindex`
|
2023-07-06 12:58:44 +08:00
|
|
|
* :ref:`search`
|
