index.rst 2.31 KB
Newer Older
Leymore's avatar
Leymore committed
1
2
3
4
5
6
7
8
欢迎来到 OpenCompass 中文教程!
==========================================

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

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

Tong Gao's avatar
Tong Gao committed
9
- 对于想要使用 OpenCompass 的用户,我们推荐先阅读 开始你的第一步_ 部分来设置环境,并启动一个迷你实验熟悉流程。
Leymore's avatar
Leymore committed
10

Tong Gao's avatar
Tong Gao committed
11
- 对于一些基础使用,我们建议用户阅读 教程_ 。
Ezra-Yu's avatar
Ezra-Yu committed
12

Tong Gao's avatar
Tong Gao committed
13
- 如果您想调整提示词(prompt),您可以浏览 提示词_ 。
Leymore's avatar
Leymore committed
14

Tong Gao's avatar
Tong Gao committed
15
- 若您想进行更多模块的自定义,例如增加数据集和模型,我们提供了 进阶教程_ 。
Leymore's avatar
Leymore committed
16

Tong Gao's avatar
Tong Gao committed
17
- 还有更多实用的工具,如提示词预览、飞书机器人上报等功能,我们同样提供了 工具_ 教程。
Leymore's avatar
Leymore committed
18
19
20
21
22
23
24
25
26


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

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

Tong Gao's avatar
Tong Gao committed
27
28
29
   get_started/installation.md
   get_started/quick_start.md
   get_started/faq.md
Leymore's avatar
Leymore committed
30
31
32
33
34
35

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

Songyang Zhang's avatar
Songyang Zhang committed
36
   user_guides/framework_overview.md
Leymore's avatar
Leymore committed
37
   user_guides/config.md
Tong Gao's avatar
Tong Gao committed
38
   user_guides/datasets.md
Leymore's avatar
Leymore committed
39
40
41
   user_guides/models.md
   user_guides/evaluation.md
   user_guides/experimentation.md
Ezra-Yu's avatar
Ezra-Yu committed
42
   user_guides/metrics.md
Leymore's avatar
Leymore committed
43
   user_guides/summarizer.md
Leymore's avatar
Leymore committed
44

Tong Gao's avatar
Tong Gao committed
45
.. _提示词:
Leymore's avatar
Leymore committed
46
47
.. toctree::
   :maxdepth: 1
Tong Gao's avatar
Tong Gao committed
48
   :caption: 提示词
Leymore's avatar
Leymore committed
49

50
   prompt/overview.md
Leymore's avatar
Leymore committed
51
52
   prompt/prompt_template.md
   prompt/meta_template.md
53
   prompt/chain_of_thought.md
Leymore's avatar
Leymore committed
54

Ezra-Yu's avatar
Ezra-Yu committed
55
56
57
58
59
60
.. _进阶教程:
.. toctree::
   :maxdepth: 1
   :caption: 进阶教程

   advanced_guides/new_dataset.md
Fengzhe Zhou's avatar
Fengzhe Zhou committed
61
   advanced_guides/custom_dataset.md
Ezra-Yu's avatar
Ezra-Yu committed
62
   advanced_guides/new_model.md
63
   advanced_guides/evaluation_turbomind.md
64
   advanced_guides/evaluation_lightllm.md
65
   advanced_guides/code_eval.md
66
   advanced_guides/code_eval_service.md
67
   advanced_guides/multimodal_eval.md
68
   advanced_guides/prompt_attack.md
69
   advanced_guides/longeval.md
70
   advanced_guides/subjective_evaluation.md
71
   advanced_guides/circular_eval.md
72
   advanced_guides/contamination_eval.md
73
   advanced_guides/compassbench_intro.md
74
   advanced_guides/needleinahaystack_eval.md
Ezra-Yu's avatar
Ezra-Yu committed
75

Leymore's avatar
Leymore committed
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
.. _工具:
.. toctree::
   :maxdepth: 1
   :caption: 工具

   tools.md

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

   notes/contribution_guide.md

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

* :ref:`genindex`
Hubert's avatar
Hubert committed
94
* :ref:`search`