Skip to content

Commit

Permalink
docs new_dataset
Browse files Browse the repository at this point in the history
  • Loading branch information
Myhs-phz committed Feb 8, 2025
1 parent c505d57 commit 089e12a
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 6 deletions.
7 changes: 3 additions & 4 deletions docs/en/advanced_guides/new_dataset.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,11 +89,11 @@ Although OpenCompass has already included most commonly used datasets, users nee
...
return dataset
```
3. After completing the dataset script and config file, you need to register the information of your new dataset in the file `dataset-index.yml` at the main directory, so that it can be added to the dataset statistics list on the OpenCompass website.

3. After completing the dataset script and config file, you need to register the information of your new dataset in the file `dataset-index.yml` at the main directory, so that it can be added to the dataset statistics list on the OpenCompass website.

- The keys that need to be filled in include `name`: the name of your dataset, `category`: the category of your dataset, `paper`: the URL of the paper or project, and `configpath`: the path to the dataset config file. Here's an example:

```
- mydataset:
name: MyDataset
Expand All @@ -102,5 +102,4 @@ Although OpenCompass has already included most commonly used datasets, users nee
configpath: opencompass/configs/datasets/MyDataset
```


Detailed dataset configuration files and other required configuration files can be referred to in the [Configuration Files](../user_guides/config.md) tutorial. For guides on launching tasks, please refer to the [Quick Start](../get_started/quick_start.md) tutorial.
4 changes: 2 additions & 2 deletions docs/zh_cn/advanced_guides/new_dataset.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,9 +92,9 @@
```

3. 在完成数据集脚本和配置文件的构建后,需要在OpenCompass主目录下的`dataset-index.yml`配置文件中登记新数据集的相关信息,以使其加入OpenCompass官网Doc的数据集统计列表中。

- 需要填写的字段包括数据集名称`name`、数据集类型`category`、原文或项目地址`paper`、以及数据集配置文件的路径`configpath`。具体示例如下:

```
- mydataset:
name: MyDataset
Expand Down

0 comments on commit 089e12a

Please sign in to comment.