Skip to content

Commit

Permalink
[Doc] Update readme (#1453)
Browse files Browse the repository at this point in the history
  • Loading branch information
MaiziXiao committed Aug 23, 2024
1 parent 5485207 commit 2295a33
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -202,14 +202,14 @@ After ensuring that OpenCompass is installed correctly according to the above st
- Your first evaluation with OpenCompass!
OpenCompass support setting your configs via CLI or a python script. For simple evaluation settings we recommend using CLI, for more complex evaluation, it is suggested using the script way. You can find more example scripts under the example_scripts folder.
OpenCompass support setting your configs via CLI or a python script. For simple evaluation settings we recommend using CLI, for more complex evaluation, it is suggested using the script way. You can find more example scripts under the configs folder.
```bash
# CLI
opencompass --models hf_internlm2_5_1_8b_chat --datasets demo_gsm8k_chat_gen
# Python scripts
opencompass example_scripts/eval_chat_demo.py
opencompass ./configs/eval_chat_demo.py
```
You can find more script examples under [configs](./configs) folder.
Expand All @@ -224,7 +224,7 @@ After ensuring that OpenCompass is installed correctly according to the above st
opencompass --models gpt_4o_2024_05_13 --datasets demo_gsm8k_chat_gen
# Python scripts
opencompass example_scripts/eval_api_demo.py
opencompass ./configs/eval_api_demo.py
```
- Accelerated Evaluation
Expand Down
6 changes: 3 additions & 3 deletions README_zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -200,14 +200,14 @@ humaneval, triviaqa, commonsenseqa, tydiqa, strategyqa, cmmlu, lambada, piqa, ce

- ### 首次评测

OpenCompass 支持通过命令行界面 (CLI) 或 Python 脚本来设置配置。对于简单的评估设置,我们推荐使用 CLI;而对于更复杂的评估,则建议使用脚本方式。你可以在example_scripts文件夹下找到更多脚本示例
OpenCompass 支持通过命令行界面 (CLI) 或 Python 脚本来设置配置。对于简单的评估设置,我们推荐使用 CLI;而对于更复杂的评估,则建议使用脚本方式。你可以在configs文件夹下找到更多脚本示例

```bash
# 命令行界面 (CLI)
opencompass --models hf_internlm2_5_1_8b_chat --datasets demo_gsm8k_chat_gen
# Python 脚本
opencompass example_scripts/eval_chat_demo.py
opencompass ./configs/eval_chat_demo.py
```

你可以在[configs](./configs) 文件夹下找到更多的脚本示例。
Expand All @@ -222,7 +222,7 @@ humaneval, triviaqa, commonsenseqa, tydiqa, strategyqa, cmmlu, lambada, piqa, ce
opencompass --models gpt_4o_2024_05_13 --datasets demo_gsm8k_chat_gen
# Python 脚本
opencompass example_scripts/eval_api_demo.py
opencompass ./configs/eval_api_demo.py
```

- ### 推理后端
Expand Down

0 comments on commit 2295a33

Please sign in to comment.