Datasets:

PM-AI
/

germandpr-beir

@@ -42,8 +42,7 @@ It already has been used to evaluate a newly trained [bi-encoder model](https://
 The benchmark framework requires a particular dataset structure by default which has been created locally and uploaded here.
 Acknowledgement: The dataset was initially created as "[germanDPR](https://www.deepset.ai/germanquad)" by Timo Möller, Julian Risch, Malte Pietsch, Julian Gutsch, Tom Hersperger, Luise Köhler, Iuliia Mozhina, and Justus Peter, during work done at deepset.ai.
-### Dataset Creation
 First, the original dataset [deepset/germanDPR](https://huggingface.co/datasets/deepset/germandpr) was converted into three files for BEIR compatibility:
  - The first file is `queries.jsonl` and contains an ID and a question in each line.
  - The second file, `corpus.jsonl`, contains in each line an ID, a title, a text and some metadata.
@@ -88,7 +87,7 @@ This means some of the results are missing.
 A correct calculation of the overall result is no longer possible.
 Have a look into [BEIR's evaluation.py](https://github.com/beir-cellar/beir/blob/c3334fd5b336dba03c5e3e605a82fcfb1bdf667d/beir/retrieval/evaluation.py#L49) for further understanding.
-### Dataset Usage
 As earlier mentioned, this dataset is intended to be used with the BEIR benchmark framework.
 The file and data structure required for BEIR can only be used to a limited extent with Huggingface Datasets or it is necessary to define multiple dataset repositories at once.
 To make it easier, the [dl_dataset.py](https://huggingface.co/datasets/PM-AI/germandpr-beir/tree/main/dl_dataset.py) script is provided to download the dataset and to ensure the correct file and folder structure.
@@ -156,18 +155,18 @@ Now you can use the downloaded files in BEIR framework:
 - Just set variable `"dataset"` to `"germandpr-beir-dataset/processed/test"` or `"germandpr-beir-dataset/original/test"`.
 - Same goes for `"train"`.
-### Dataset Sizes
 - Original **train** `corpus` size, `queries` size and `qrels` size: `24009`, `9275` and `9275`
 - Original **test** `corpus` size, `queries` size and `qrels` size: `2876`, `1025` and `1025`
 - Processed **train** `corpus` size, `queries` size and `qrels` size: `23993`, `9275` and `9275`
 - Processed **test** `corpus` size, `queries` size and `qrels` size: `2875` and `1025` and `1025`
-### Languages
 This dataset only supports german (aka. de, DE).
-### Acknowledgment
 The dataset was initially created as "[deepset/germanDPR](https://www.deepset.ai/germanquad)" by Timo Möller, Julian Risch, Malte Pietsch, Julian Gutsch, Tom Hersperger, Luise Köhler, Iuliia Mozhina, and Justus Peter, during work done at [deepset.ai](https://www.deepset.ai/).

 The benchmark framework requires a particular dataset structure by default which has been created locally and uploaded here.
 Acknowledgement: The dataset was initially created as "[germanDPR](https://www.deepset.ai/germanquad)" by Timo Möller, Julian Risch, Malte Pietsch, Julian Gutsch, Tom Hersperger, Luise Köhler, Iuliia Mozhina, and Justus Peter, during work done at deepset.ai.
+## Dataset Creation
 First, the original dataset [deepset/germanDPR](https://huggingface.co/datasets/deepset/germandpr) was converted into three files for BEIR compatibility:
  - The first file is `queries.jsonl` and contains an ID and a question in each line.
  - The second file, `corpus.jsonl`, contains in each line an ID, a title, a text and some metadata.
 A correct calculation of the overall result is no longer possible.
 Have a look into [BEIR's evaluation.py](https://github.com/beir-cellar/beir/blob/c3334fd5b336dba03c5e3e605a82fcfb1bdf667d/beir/retrieval/evaluation.py#L49) for further understanding.
+## Dataset Usage
 As earlier mentioned, this dataset is intended to be used with the BEIR benchmark framework.
 The file and data structure required for BEIR can only be used to a limited extent with Huggingface Datasets or it is necessary to define multiple dataset repositories at once.
 To make it easier, the [dl_dataset.py](https://huggingface.co/datasets/PM-AI/germandpr-beir/tree/main/dl_dataset.py) script is provided to download the dataset and to ensure the correct file and folder structure.
 - Just set variable `"dataset"` to `"germandpr-beir-dataset/processed/test"` or `"germandpr-beir-dataset/original/test"`.
 - Same goes for `"train"`.
+## Dataset Sizes
 - Original **train** `corpus` size, `queries` size and `qrels` size: `24009`, `9275` and `9275`
 - Original **test** `corpus` size, `queries` size and `qrels` size: `2876`, `1025` and `1025`
 - Processed **train** `corpus` size, `queries` size and `qrels` size: `23993`, `9275` and `9275`
 - Processed **test** `corpus` size, `queries` size and `qrels` size: `2875` and `1025` and `1025`
+## Languages
 This dataset only supports german (aka. de, DE).
+## Acknowledgment
 The dataset was initially created as "[deepset/germanDPR](https://www.deepset.ai/germanquad)" by Timo Möller, Julian Risch, Malte Pietsch, Julian Gutsch, Tom Hersperger, Luise Köhler, Iuliia Mozhina, and Justus Peter, during work done at [deepset.ai](https://www.deepset.ai/).