"vscode:/vscode.git/clone" did not exist on "d5c10e7a962871ad8bd0371312ef04296d6a36f8"
index.rst 1.55 KB
Newer Older
gaotongxiao's avatar
gaotongxiao committed
1
2
3
Welcome to OpenCompass' documentation!
==========================================

Tong Gao's avatar
Tong Gao committed
4
Getting started with OpenCompass
gaotongxiao's avatar
gaotongxiao committed
5
6
-------------------------------

Tong Gao's avatar
Tong Gao committed
7
To help you quickly familiarized with OpenCompass, we recommend you to walk through the following documents in order:
gaotongxiao's avatar
gaotongxiao committed
8

Tong Gao's avatar
Tong Gao committed
9
- First read the GetStarted_ section set up the environment, and run a mini experiment.
gaotongxiao's avatar
gaotongxiao committed
10

Tong Gao's avatar
Tong Gao committed
11
- Then learn its basic usage through the UserGuides_.
gaotongxiao's avatar
gaotongxiao committed
12

Tong Gao's avatar
Tong Gao committed
13
- If you want to tune the prompts, refer to the Prompt_.
gaotongxiao's avatar
gaotongxiao committed
14

Tong Gao's avatar
Tong Gao committed
15
- If you want to customize some modules, like adding a new dataset or model, we have provided the AdvancedGuides_.
gaotongxiao's avatar
gaotongxiao committed
16

Tong Gao's avatar
Tong Gao committed
17
- There are more handy tools, such as prompt viewer and lark bot reporter, all presented in Tools_.
gaotongxiao's avatar
gaotongxiao committed
18

Tong Gao's avatar
Tong Gao committed
19
We always welcome *PRs* and *Issues* for the betterment of OpenCompass.
gaotongxiao's avatar
gaotongxiao committed
20
21
22
23
24
25
26
27
28
29
30

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

   get_started.md

.. _UserGuides:
.. toctree::
   :maxdepth: 1
Tong Gao's avatar
Tong Gao committed
31
   :caption: User Guides
gaotongxiao's avatar
gaotongxiao committed
32
33

   user_guides/config.md
Tong Gao's avatar
Tong Gao committed
34
   user_guides/datasets.md
gaotongxiao's avatar
gaotongxiao committed
35
36
37
38
39
40
41
   user_guides/models.md
   user_guides/evaluation.md
   user_guides/experimentation.md

.. _AdvancedGuides:
.. toctree::
   :maxdepth: 1
Tong Gao's avatar
Tong Gao committed
42
   :caption: Advanced Guides
gaotongxiao's avatar
gaotongxiao committed
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73

   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`
Hubert's avatar
Hubert committed
74
* :ref:`search`