2023-07-05 10:33:12 +08:00
|
|
|
|
欢迎来到 OpenCompass 中文教程！
|
|
|
|
|
|
==========================================
|
|
|
|
|
|
|
|
|
|
|
|
OpenCompass 上手路线
|
|
|
|
|
|
-------------------------------
|
|
|
|
|
|
|
|
|
|
|
|
为了用户能够快速上手，我们推荐以下流程：
|
|
|
|
|
|
|
2023-07-13 09:07:53 +08:00
|
|
|
|
- 对于想要使用 OpenCompass 的用户，我们推荐先阅读 开始你的第一步_ 部分来设置环境，并启动一个迷你实验熟悉流程。
|
2023-07-05 10:33:12 +08:00
|
|
|
|
|
2023-07-13 09:07:53 +08:00
|
|
|
|
- 对于一些基础使用，我们建议用户阅读 教程_ 。
|
2023-07-06 12:41:17 +08:00
|
|
|
|
|
2023-07-13 09:07:53 +08:00
|
|
|
|
- 如果您想调整提示词（prompt），您可以浏览 提示词_ 。
|
2023-07-05 10:33:12 +08:00
|
|
|
|
|
2023-07-13 09:07:53 +08:00
|
|
|
|
- 若您想进行更多模块的自定义，例如增加数据集和模型，我们提供了 进阶教程_ 。
|
2023-07-05 10:33:12 +08:00
|
|
|
|
|
2023-07-13 09:07:53 +08:00
|
|
|
|
- 还有更多实用的工具，如提示词预览、飞书机器人上报等功能，我们同样提供了 工具_ 教程。
|
2023-07-05 10:33:12 +08:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
我们始终非常欢迎用户的 PRs 和 Issues 来完善 OpenCompass！
|
|
|
|
|
|
|
|
|
|
|
|
.. _开始你的第一步:
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
|
:maxdepth: 1
|
|
|
|
|
|
:caption: 开始你的第一步
|
|
|
|
|
|
|
2023-10-07 11:49:40 +08:00
|
|
|
|
get_started/installation.md
|
|
|
|
|
|
get_started/quick_start.md
|
|
|
|
|
|
get_started/faq.md
|
2023-07-05 10:33:12 +08:00
|
|
|
|
|
|
|
|
|
|
.. _教程:
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
|
:maxdepth: 1
|
|
|
|
|
|
:caption: 教程
|
|
|
|
|
|
|
2023-09-07 14:21:39 +08:00
|
|
|
|
user_guides/framework_overview.md
|
2023-07-05 10:33:12 +08:00
|
|
|
|
user_guides/config.md
|
2023-07-13 09:07:53 +08:00
|
|
|
|
user_guides/datasets.md
|
2023-07-05 10:33:12 +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-08-23 11:18:01 +08:00
|
|
|
|
user_guides/summarizer.md
|
2024-04-30 00:09:08 +08:00
|
|
|
|
user_guides/corebench.md
|
2023-07-05 10:33:12 +08:00
|
|
|
|
|
2023-07-13 09:07:53 +08:00
|
|
|
|
.. _提示词:
|
2023-07-05 10:33:12 +08:00
|
|
|
|
.. toctree::
|
|
|
|
|
|
:maxdepth: 1
|
2023-07-13 09:07:53 +08:00
|
|
|
|
:caption: 提示词
|
2023-07-05 10:33:12 +08:00
|
|
|
|
|
2023-08-11 11:36:09 +08:00
|
|
|
|
prompt/overview.md
|
2023-07-05 10:33:12 +08:00
|
|
|
|
prompt/prompt_template.md
|
|
|
|
|
|
prompt/meta_template.md
|
2023-08-11 11:36:09 +08:00
|
|
|
|
prompt/chain_of_thought.md
|
2023-07-05 10:33:12 +08:00
|
|
|
|
|
2023-07-06 12:41:17 +08:00
|
|
|
|
.. _进阶教程:
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
|
:maxdepth: 1
|
|
|
|
|
|
:caption: 进阶教程
|
|
|
|
|
|
|
|
|
|
|
|
advanced_guides/new_dataset.md
|
2023-12-25 21:59:16 +08:00
|
|
|
|
advanced_guides/custom_dataset.md
|
2023-07-06 12:41:17 +08:00
|
|
|
|
advanced_guides/new_model.md
|
2024-10-14 15:33:40 +08:00
|
|
|
|
advanced_guides/evaluation_lmdeploy.md
|
2023-11-21 19:18:40 +08:00
|
|
|
|
advanced_guides/evaluation_lightllm.md
|
2024-08-20 22:02:14 +08:00
|
|
|
|
advanced_guides/accelerator_intro.md
|
2023-11-22 13:37:53 +08:00
|
|
|
|
advanced_guides/code_eval.md
|
2023-08-17 11:03:16 +08:00
|
|
|
|
advanced_guides/code_eval_service.md
|
2023-09-15 15:06:53 +08:00
|
|
|
|
advanced_guides/prompt_attack.md
|
2023-09-18 17:06:00 +08:00
|
|
|
|
advanced_guides/longeval.md
|
2023-10-27 16:27:24 +08:00
|
|
|
|
advanced_guides/subjective_evaluation.md
|
2023-11-23 16:45:47 +08:00
|
|
|
|
advanced_guides/circular_eval.md
|
2023-12-08 10:00:11 +08:00
|
|
|
|
advanced_guides/contamination_eval.md
|
2024-01-05 20:39:36 +08:00
|
|
|
|
advanced_guides/compassbench_intro.md
|
2024-01-17 13:47:34 +08:00
|
|
|
|
advanced_guides/needleinahaystack_eval.md
|
2023-07-06 12:41:17 +08:00
|
|
|
|
|
2023-07-05 10:33:12 +08:00
|
|
|
|
.. _工具:
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
|
:maxdepth: 1
|
|
|
|
|
|
:caption: 工具
|
|
|
|
|
|
|
|
|
|
|
|
tools.md
|
|
|
|
|
|
|
2025-02-14 16:17:30 +08:00
|
|
|
|
.. _数据集列表:
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
|
:maxdepth: 1
|
|
|
|
|
|
:caption: 数据集列表
|
|
|
|
|
|
|
|
|
|
|
|
dataset_statistics.md
|
|
|
|
|
|
|
2023-07-05 10:33:12 +08:00
|
|
|
|
.. _其他说明:
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
|
:maxdepth: 1
|
|
|
|
|
|
:caption: 其他说明
|
|
|
|
|
|
|
|
|
|
|
|
notes/contribution_guide.md
|
|
|
|
|
|
|
|
|
|
|
|
索引与表格
|
|
|
|
|
|
==================
|
|
|
|
|
|
|
|
|
|
|
|
* :ref:`genindex`
|
2023-07-06 12:58:44 +08:00
|
|
|
|
* :ref:`search`
|
