jiangzhs/OpenCompass
1
0
Fork 0
mirror of https://github.com/open-compass/opencompass.git synced 2025-05-30 16:03:24 +08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
c26ecdb1b0
OpenCompass/docs/zh_cn/tools.md
Leymore c26ecdb1b0
[Feature] Add and apply update suffix tool (#280) 
* add and apply update suffix tool

* add dataset suffix updater as precommit hook

* update workflow

* update scripts

* update ci

* update

* ci with py3.8

* run in serial

* update bbh

* use py 3.10

* update pre commit zh cn
2023-08-28 17:35:04 +08:00

2.5 KiB
Raw Blame History

实用工具

Prompt Viewer

本工具允许你在不启动完整训练流程的情况下，直接查看生成的 prompt。如果传入的配置仅为数据集配置（如 configs/datasets/nq/nq_gen_3dcea1.py），则展示数据集配置中定义的原始 prompt。若为完整的评测配置（包含模型和数据集），则会展示所选模型运行时实际接收到的 prompt。

运行方式：

python tools/prompt_viewer.py CONFIG_PATH [-n] [-a] [-p PATTERN]
  • -n: 不进入交互模式，默认选择第一个 model （如有）和 dataset。
  • -a: 查看配置中所有模型和所有数据集组合接收到的 prompt。
  • -p PATTERN: 不进入交互模式，选择所有与传入正则表达式匹配的数据集。

Case Analyzer

本工具在已有评测结果的基础上，产出推理错误样本以及带有标注信息的全量样本。

运行方式：

python tools/case_analyzer.py CONFIG_PATH [-w WORK_DIR]
  • -w：工作路径，默认为 './outputs/default'。

Lark Bot

用户可以通过配置飞书机器人，实现任务状态的实时监控。飞书机器人的设置文档请参考这里。

配置方式:

  • 打开 configs/secrets.py 文件，并在文件中加入以下行：

    lark_bot_url = 'YOUR_WEBHOOK_URL'

    通常， Webhook URL 格式如 https://open.feishu.cn/open-apis/bot/v2/hook/xxxxxxxxxxxxxxxxx 。

  • 在完整的评测配置中继承该文件：

      _base_ = [
      'secrets.py',
      ...
  ]

    实例可见 configs/eval.py。

  • 为了避免机器人频繁发消息形成骚扰，默认运行时状态不会自动上报。有需要时，可以通过 -l 或 --lark 启动状态上报：

    python run.py configs/eval_demo.py -l

API Model Tester

本工具可以快速测试 API 模型的功能是否正常。

运行方式：

python tools/test_api_model.py [CONFIG_PATH] -n

Prediction Merger

本工具可以合并由于 partitioner 而产生的分片推理结果。

运行方式：

python tools/prediction_merger.py CONFIG_PATH [-w WORK_DIR]
  • -w：工作路径，默认为 './outputs/default'。

Dataset Suffix Updater

本工具可以快速修改 configs/dataset 目录下的配置文件后缀，使其符合提示词哈希命名规范。

运行方式：

python tools/update_dataset_suffix.py