Datasets:
Update README using proper template
Browse files
README.md
CHANGED
|
@@ -1,23 +1,111 @@
|
|
| 1 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 2 |
|
| 3 |
-
|
| 4 |
|
| 5 |
-
|
| 6 |
-
- **Corpus**: 10 documents (tweaked text)
|
| 7 |
-
- **Queries**: 6 queries (tweaked text)
|
| 8 |
-
- **QRels**: 6 relevance judgments
|
| 9 |
|
| 10 |
-
##
|
| 11 |
-
|
| 12 |
-
|
| 13 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 14 |
|
| 15 |
## Usage
|
| 16 |
|
| 17 |
-
|
| 18 |
-
|
| 19 |
-
|
| 20 |
-
|
| 21 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 22 |
|
| 23 |
-
|
|
|
|
| 1 |
+
---
|
| 2 |
+
annotations_creators:
|
| 3 |
+
- derived
|
| 4 |
+
language:
|
| 5 |
+
- fr
|
| 6 |
+
license: other
|
| 7 |
+
multilinguality: monolingual
|
| 8 |
+
task_categories:
|
| 9 |
+
- text-retrieval
|
| 10 |
+
task_ids:
|
| 11 |
+
- document-retrieval
|
| 12 |
+
tags:
|
| 13 |
+
- mteb
|
| 14 |
+
- text
|
| 15 |
+
- retrieval
|
| 16 |
+
- sample
|
| 17 |
+
configs:
|
| 18 |
+
- config_name: corpus
|
| 19 |
+
data_files:
|
| 20 |
+
- split: train
|
| 21 |
+
path: corpus/train-*
|
| 22 |
+
- config_name: default
|
| 23 |
+
data_files:
|
| 24 |
+
- split: test
|
| 25 |
+
path: data/test-*
|
| 26 |
+
- config_name: queries
|
| 27 |
+
data_files:
|
| 28 |
+
- split: train
|
| 29 |
+
path: queries/train-*
|
| 30 |
+
dataset_info:
|
| 31 |
+
- config_name: corpus
|
| 32 |
+
features:
|
| 33 |
+
- name: _id
|
| 34 |
+
dtype: string
|
| 35 |
+
- name: title
|
| 36 |
+
dtype: string
|
| 37 |
+
- name: text
|
| 38 |
+
dtype: string
|
| 39 |
+
splits:
|
| 40 |
+
- name: train
|
| 41 |
+
num_examples: 10
|
| 42 |
+
- config_name: default
|
| 43 |
+
features:
|
| 44 |
+
- name: query-id
|
| 45 |
+
dtype: string
|
| 46 |
+
- name: corpus-id
|
| 47 |
+
dtype: string
|
| 48 |
+
- name: score
|
| 49 |
+
dtype: int64
|
| 50 |
+
splits:
|
| 51 |
+
- name: test
|
| 52 |
+
num_examples: 6
|
| 53 |
+
- config_name: queries
|
| 54 |
+
features:
|
| 55 |
+
- name: _id
|
| 56 |
+
dtype: string
|
| 57 |
+
- name: text
|
| 58 |
+
dtype: string
|
| 59 |
+
splits:
|
| 60 |
+
- name: train
|
| 61 |
+
num_examples: 6
|
| 62 |
+
---
|
| 63 |
|
| 64 |
+
# FrenchLegal1Retrieval-sample
|
| 65 |
|
| 66 |
+
A sample dataset for French legal document retrieval evaluation.
|
|
|
|
|
|
|
|
|
|
| 67 |
|
| 68 |
+
## Task category
|
| 69 |
+
|
| 70 |
+
Retrieval
|
| 71 |
+
|
| 72 |
+
## Domains
|
| 73 |
+
|
| 74 |
+
Legal, Government
|
| 75 |
+
|
| 76 |
+
## Dataset Structure
|
| 77 |
+
|
| 78 |
+
The dataset follows the standard MTEB retrieval format:
|
| 79 |
+
|
| 80 |
+
- `corpus/corpus-00000-of-00001.parquet`: 10 documents with fields `_id`, `title`, `text`
|
| 81 |
+
- `queries/queries-00000-of-00001.parquet`: 6 queries with fields `_id`, `text`
|
| 82 |
+
- `data/test-00000-of-00001.parquet`: 6 relevance judgments with fields `query-id`, `corpus-id`, `score`
|
| 83 |
|
| 84 |
## Usage
|
| 85 |
|
| 86 |
+
You can evaluate an embedding model on this sample dataset using the following code:
|
| 87 |
+
|
| 88 |
+
```python
|
| 89 |
+
import mteb
|
| 90 |
+
|
| 91 |
+
# Load the sample dataset
|
| 92 |
+
task = mteb.get_task("FrenchLegal1Retrieval")
|
| 93 |
+
evaluator = mteb.MTEB(tasks=[task])
|
| 94 |
+
|
| 95 |
+
# Run evaluation with your model
|
| 96 |
+
model = mteb.get_model("your-model-name")
|
| 97 |
+
results = evaluator.run(model)
|
| 98 |
+
```
|
| 99 |
+
|
| 100 |
+
## Sample Content
|
| 101 |
+
|
| 102 |
+
This sample dataset contains:
|
| 103 |
+
- 6 queries describing information needs
|
| 104 |
+
- 10 corresponding documents
|
| 105 |
+
- 6 relevance judgments connecting queries to documents
|
| 106 |
+
|
| 107 |
+
The data has been slightly modified for demonstration purposes while preserving the original structure and meaning.
|
| 108 |
+
|
| 109 |
+
## License
|
| 110 |
|
| 111 |
+
other
|