nreimers commited on
Commit
d359630
1 Parent(s): 545acc5

update readme

Browse files
Files changed (1) hide show
  1. README.md +25 -4
README.md CHANGED
@@ -4,6 +4,15 @@
4
 
5
  This dataset repository contains files that are helpful to train bi-encoder models e.g. using [sentence-transformers](https://www.sbert.net).
6
 
 
 
 
 
 
 
 
 
 
7
  ## msmarco-hard-negatives.jsonl.gz
8
  This is a jsonl file: Each line is a JSON object. It has the following format:
9
  ```
@@ -12,8 +21,20 @@ This is a jsonl file: Each line is a JSON object. It has the following format:
12
 
13
  `qid` is the query-ID from MS MARCO, `pos` is a list with paragraph IDs for positive passages. `neg` is a dictionary where we mined hard negatives using different (mainly dense retrieval) systems.
14
 
15
- ## cross-encoder-ms-marco-MiniLM-L-6-v2-scores.pkl.gz
16
-
17
- This is a pickled dictionary in the format: `scores[qid][pid] -> cross_encoder_score`
 
 
 
 
 
 
 
 
 
 
 
 
18
 
19
- It contains 160 million cross-encoder scores for (query, paragraph) pairs using the [cross-encoder/ms-marco-MiniLM-L-6-v2](https://huggingface.co/cross-encoder/ms-marco-MiniLM-L-6-v2) model.
4
 
5
  This dataset repository contains files that are helpful to train bi-encoder models e.g. using [sentence-transformers](https://www.sbert.net).
6
 
7
+ ## Training Code
8
+ You can find here an example how these files can be used to train bi-encoders: [SBERT.net - MS MARCO - MarginMSE](https://www.sbert.net/examples/training/ms_marco/README.html#marginmse)
9
+
10
+ ## cross-encoder-ms-marco-MiniLM-L-6-v2-scores.pkl.gz
11
+
12
+ This is a pickled dictionary in the format: `scores[qid][pid] -> cross_encoder_score`
13
+
14
+ It contains 160 million cross-encoder scores for (query, paragraph) pairs using the [cross-encoder/ms-marco-MiniLM-L-6-v2](https://huggingface.co/cross-encoder/ms-marco-MiniLM-L-6-v2) model.
15
+
16
  ## msmarco-hard-negatives.jsonl.gz
17
  This is a jsonl file: Each line is a JSON object. It has the following format:
18
  ```
21
 
22
  `qid` is the query-ID from MS MARCO, `pos` is a list with paragraph IDs for positive passages. `neg` is a dictionary where we mined hard negatives using different (mainly dense retrieval) systems.
23
 
24
+ It contains hard negatives mined from BM25 (using ElasticSearch) and the following dense models:
25
+ ```
26
+ msmarco-distilbert-base-tas-b
27
+ msmarco-distilbert-base-v3
28
+ msmarco-MiniLM-L-6-v3
29
+ distilbert-margin_mse-cls-dot-v2
30
+ distilbert-margin_mse-cls-dot-v1
31
+ distilbert-margin_mse-mean-dot-v1
32
+ mpnet-margin_mse-mean-v1
33
+ co-condenser-margin_mse-cls-v1
34
+ distilbert-margin_mse-mnrl-mean-v1
35
+ distilbert-margin_mse-sym_mnrl-mean-v1
36
+ distilbert-margin_mse-sym_mnrl-mean-v2
37
+ co-condenser-margin_mse-sym_mnrl-mean-v1
38
+ ```
39
 
40
+ From each system, 50 most similar paragraphs were mined for a given query.