Skip to content

Commit 7842388

Browse files
committed
Evaluation tutorials
1 parent b1849f8 commit 7842388

7 files changed

Lines changed: 1431 additions & 1 deletion

File tree

Tutorials/4_Evaluation/4.4.1_Sentence_Transformers_Eval.ipynb renamed to Tutorials/4_Evaluation/4.3.1_Sentence_Transformers_Eval.ipynb

File renamed without changes.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@
4949
"cell_type": "markdown",
5050
"metadata": {},
5151
"source": [
52-
"BEIR contains 18 datasets which can be downloaded from the [link](https://public.ukp.informatik.tu-darmstadt.de/thakur/BEIR/datasets/), while 4 of them are private datasets that need appropriate licences. If you want to access to those 4 datasets, take a look at their [wiki](https://github.com/beir-cellar/beir/wiki/Datasets-available) for more information. "
52+
"BEIR contains 18 datasets which can be downloaded from the [link](https://public.ukp.informatik.tu-darmstadt.de/thakur/BEIR/datasets/), while 4 of them are private datasets that need appropriate licences. If you want to access to those 4 datasets, take a look at their [wiki](https://github.com/beir-cellar/beir/wiki/Datasets-available) for more information. Information collected and codes adapted from BEIR GitHub [repo](https://github.com/beir-cellar/beir)."
5353
]
5454
},
5555
{

Tutorials/4_Evaluation/4.5.1_MIRACL.ipynb

Lines changed: 738 additions & 0 deletions
Large diffs are not rendered by default.

Tutorials/4_Evaluation/4.5.2_MLDR.ipynb

Lines changed: 615 additions & 0 deletions
Large diffs are not rendered by default.
Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
{
2+
"cells": [
3+
{
4+
"cell_type": "markdown",
5+
"metadata": {},
6+
"source": [
7+
"# Evaluate on MKQA"
8+
]
9+
},
10+
{
11+
"cell_type": "markdown",
12+
"metadata": {},
13+
"source": [
14+
"[MKQA](https://github.com/apple/ml-mkqa) is an open-domain question answering evaluation set comprising 10k question-answer pairs aligned across 26 typologically diverse languages."
15+
]
16+
},
17+
{
18+
"cell_type": "markdown",
19+
"metadata": {},
20+
"source": [
21+
"## 0. Installation"
22+
]
23+
},
24+
{
25+
"cell_type": "markdown",
26+
"metadata": {},
27+
"source": [
28+
"First install the library we are using:"
29+
]
30+
},
31+
{
32+
"cell_type": "code",
33+
"execution_count": null,
34+
"metadata": {},
35+
"outputs": [],
36+
"source": [
37+
"# % pip install FlagEmbedding"
38+
]
39+
},
40+
{
41+
"cell_type": "markdown",
42+
"metadata": {},
43+
"source": [
44+
"## 1. Dataset"
45+
]
46+
},
47+
{
48+
"cell_type": "markdown",
49+
"metadata": {},
50+
"source": [
51+
"MKQA contains 10,000 queries sampled from the [Google Natural Questions dataset](https://github.com/google-research-datasets/natural-questions). We use the well-processed [corpus](https://huggingface.co/datasets/BeIR/nq) of NQ offered by the BEIR."
52+
]
53+
}
54+
],
55+
"metadata": {
56+
"kernelspec": {
57+
"display_name": "dev",
58+
"language": "python",
59+
"name": "python3"
60+
},
61+
"language_info": {
62+
"codemirror_mode": {
63+
"name": "ipython",
64+
"version": 3
65+
},
66+
"file_extension": ".py",
67+
"mimetype": "text/x-python",
68+
"name": "python",
69+
"nbconvert_exporter": "python",
70+
"pygments_lexer": "ipython3",
71+
"version": "3.12.7"
72+
}
73+
},
74+
"nbformat": 4,
75+
"nbformat_minor": 2
76+
}

docs/source/API/evaluation/mkqa.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ MKQA
22
====
33

44
`MKQA <https://github.com/apple/ml-mkqa>`_ is an open-domain question answering evaluation set comprising 10k question-answer pairs aligned across 26 typologically diverse languages.
5+
The queries are sampled from the [Google Natural Questions Dataset](https://github.com/google-research-datasets/natural-questions).
56

67
Each example in the dataset has the following structure:
78

0 commit comments

Comments
 (0)