Skip to content

Commit

Permalink
[Doc] Update README (#1404)
Browse files Browse the repository at this point in the history
* [Doc] Update README

* Update
  • Loading branch information
tonysy authored Aug 8, 2024
1 parent decb621 commit 88eb912
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 3 deletions.
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,10 @@ pip install -e .

### 📂 Data Preparation

You can choose one for the following method to prepare datasets.

#### Offline Preparation

You can download and extract the datasets with the following commands:

```bash
Expand All @@ -146,12 +150,19 @@ wget https://github.com/open-compass/opencompass/releases/download/0.2.2.rc1/Ope
unzip OpenCompassData-core-20240207.zip
```

Also, use the [ModelScope](www.modelscope.cn) to load the datasets on demand.
#### Automatic Download from OpenCompass

We have supported download datasets automatic from the OpenCompass storage server. You can run the evaluation with extra `--dry-run` to download these datasets.
Currently, the supported datasets are listed in [here](https://github.com/open-compass/opencompass/blob/main/opencompass/utils/datasets_info.py#L259). More datasets will be uploaded recently.

#### (Optional) Automatic Download with ModelScope

Also you can use the [ModelScope](www.modelscope.cn) to load the datasets on demand.

Installation:

```bash
pip install modelscope
pip install modelscope[framework]
export DATASET_SOURCE=ModelScope
```

Expand Down
9 changes: 9 additions & 0 deletions README_zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,8 @@ pip install -e .

### 📂 数据准备

#### 提前离线下载

OpenCompass支持使用本地数据集进行评测,数据集的下载和解压可以通过以下命令完成:

```bash
Expand All @@ -148,6 +150,13 @@ wget https://github.com/open-compass/opencompass/releases/download/0.2.2.rc1/Ope
unzip OpenCompassData-core-20240207.zip
```

#### 从 OpenCompass 自动下载

我们已经支持从OpenCompass存储服务器自动下载数据集。您可以通过额外的 `--dry-run` 参数来运行评估以下载这些数据集。
目前支持的数据集列表在[这里](https://github.com/open-compass/opencompass/blob/main/opencompass/utils/datasets_info.py#L259)。更多数据集将会很快上传。

#### (可选) 使用 ModelScope 自动下载

另外,您还可以使用[ModelScope](www.modelscope.cn)来加载数据集:
环境准备:

Expand Down
2 changes: 1 addition & 1 deletion opencompass/runners/volc.py
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,7 @@ def _run_task(self, cmd, log_path, poll_interval):
f.write(logs)
if task_status in [
'Success', 'Failed', 'Cancelled', 'Exception',
'Killing'
'Killing', 'SuccessHolding', 'FailedHolding'
]:
break
time.sleep(poll_interval)
Expand Down

0 comments on commit 88eb912

Please sign in to comment.