hotchpotch commited on
Commit
f3fdd80
·
verified ·
1 Parent(s): 48e5105

Update dataset README for reranking_hybrid candidates

Browse files
Files changed (1) hide show
  1. README.md +98 -88
README.md CHANGED
@@ -145,161 +145,171 @@ dataset_info:
145
  download_size: 807492
146
  dataset_size: 803136
147
  configs:
148
- - config_name: bm25
149
  data_files:
150
  - split: NanoBIRCOArguAna
151
- path: bm25/NanoBIRCOArguAna-*
152
  - split: NanoBIRCOClinicalTrial
153
- path: bm25/NanoBIRCOClinicalTrial-*
154
  - split: NanoBIRCODorisMae
155
- path: bm25/NanoBIRCODorisMae-*
156
  - split: NanoBIRCORelic
157
- path: bm25/NanoBIRCORelic-*
158
  - split: NanoBIRCOWTB
159
- path: bm25/NanoBIRCOWTB-*
160
- - config_name: corpus
161
  data_files:
162
  - split: NanoBIRCOArguAna
163
- path: corpus/NanoBIRCOArguAna-*
164
  - split: NanoBIRCOClinicalTrial
165
- path: corpus/NanoBIRCOClinicalTrial-*
166
  - split: NanoBIRCODorisMae
167
- path: corpus/NanoBIRCODorisMae-*
168
  - split: NanoBIRCORelic
169
- path: corpus/NanoBIRCORelic-*
170
  - split: NanoBIRCOWTB
171
- path: corpus/NanoBIRCOWTB-*
172
- - config_name: harrier_oss_v1_270m
 
173
  data_files:
174
  - split: NanoBIRCOArguAna
175
- path: harrier_oss_v1_270m/NanoBIRCOArguAna-*
176
  - split: NanoBIRCOClinicalTrial
177
- path: harrier_oss_v1_270m/NanoBIRCOClinicalTrial-*
178
  - split: NanoBIRCODorisMae
179
- path: harrier_oss_v1_270m/NanoBIRCODorisMae-*
180
  - split: NanoBIRCORelic
181
- path: harrier_oss_v1_270m/NanoBIRCORelic-*
182
  - split: NanoBIRCOWTB
183
- path: harrier_oss_v1_270m/NanoBIRCOWTB-*
184
- - config_name: qrels
185
  data_files:
186
  - split: NanoBIRCOArguAna
187
- path: qrels/NanoBIRCOArguAna-*
188
  - split: NanoBIRCOClinicalTrial
189
- path: qrels/NanoBIRCOClinicalTrial-*
190
  - split: NanoBIRCODorisMae
191
- path: qrels/NanoBIRCODorisMae-*
192
  - split: NanoBIRCORelic
193
- path: qrels/NanoBIRCORelic-*
194
  - split: NanoBIRCOWTB
195
- path: qrels/NanoBIRCOWTB-*
196
- - config_name: queries
197
  data_files:
198
  - split: NanoBIRCOArguAna
199
- path: queries/NanoBIRCOArguAna-*
200
  - split: NanoBIRCOClinicalTrial
201
- path: queries/NanoBIRCOClinicalTrial-*
202
  - split: NanoBIRCODorisMae
203
- path: queries/NanoBIRCODorisMae-*
204
  - split: NanoBIRCORelic
205
- path: queries/NanoBIRCORelic-*
206
  - split: NanoBIRCOWTB
207
- path: queries/NanoBIRCOWTB-*
208
- default: true
209
  - config_name: reranking_hybrid
210
  data_files:
211
  - split: NanoBIRCOArguAna
212
- path: reranking_hybrid/NanoBIRCOArguAna-*
213
  - split: NanoBIRCOClinicalTrial
214
- path: reranking_hybrid/NanoBIRCOClinicalTrial-*
215
  - split: NanoBIRCODorisMae
216
- path: reranking_hybrid/NanoBIRCODorisMae-*
217
  - split: NanoBIRCORelic
218
- path: reranking_hybrid/NanoBIRCORelic-*
219
  - split: NanoBIRCOWTB
220
- path: reranking_hybrid/NanoBIRCOWTB-*
 
 
 
 
 
 
 
 
221
  ---
222
-
223
  # NanoBIRCO
224
 
225
- This dataset is a Nano-style retrieval dataset. Nano-series evaluation can be run easily with [HAKARI-Bench](https://github.com/hotchpotch/hakari-bench).
226
-
227
- NanoBIRCO is derived from BIRCO. It follows the Hugging Face Datasets layout convention used by [sentence-transformers/NanoBEIR-en](https://huggingface.co/datasets/sentence-transformers/NanoBEIR-en): each Nano split has separate `corpus`, `queries`, and `qrels` tables, and BM25 candidates are provided separately in a `bm25` table. This layout follows the NanoBEIR-style evaluation approach summarized in [NanoBEIR](https://huggingface.co/blog/sionic-ai/eval-sionic-nano-beir).
228
 
229
  NanoBIRCO contains 5 Nano retrieval splits derived from BIRCO. Each split keeps up to 200 eligible queries and up to 10000 corpus documents, with exact duplicate query and document text removed where the generator records that policy.
230
 
231
- ## Source Links
232
 
233
- - Source benchmark: `BIRCO`
234
- - Source benchmark repository: https://github.com/embeddings-benchmark/mteb
235
- - `mteb/BIRCO-ArguAna-Test`: https://huggingface.co/datasets/mteb/BIRCO-ArguAna-Test
236
- - `mteb/BIRCO-ClinicalTrial-Test`: https://huggingface.co/datasets/mteb/BIRCO-ClinicalTrial-Test
237
- - `mteb/BIRCO-DorisMae-Test`: https://huggingface.co/datasets/mteb/BIRCO-DorisMae-Test
238
- - `mteb/BIRCO-Relic-Test`: https://huggingface.co/datasets/mteb/BIRCO-Relic-Test
239
- - `mteb/BIRCO-WTB-Test`: https://huggingface.co/datasets/mteb/BIRCO-WTB-Test
 
 
 
 
240
 
241
  ## Data Layout
242
 
243
- This dataset uses four Hugging Face Datasets configs:
244
 
245
  - `corpus`: documents with `_id` and `text`
246
  - `queries`: queries with `_id` and `text`
247
  - `qrels`: positive relevance labels with `query-id` and `corpus-id`
248
  - `bm25`: BM25 candidate lists with `query-id` and `corpus-ids`
 
 
249
 
250
- Each config uses the same Nano split names. If the actual generated dataset uses a different schema, config name, path layout, or field name, revise this section before publishing the README.
251
-
252
- ## Construction Steps
253
 
254
- This dataset was built as follows. If the actual generation procedure differs, revise this section before publishing the README.
255
 
256
- 1. Use BIRCO as the upstream benchmark or dataset family.
257
- 2. Load the source datasets recorded in `manifest.json` and per-split metadata files.
258
- 3. Use the evaluation splits selected by `scripts/create_mteb_nano_series_local.py` as the source evaluation split policy.
259
- 4. Create one Nano split for each selected source retrieval task.
260
- 5. Keep up to 200 eligible queries per Nano split.
261
- 6. Include qrels-positive documents for the selected queries. For graded qrels, only rows with `score > 0` are treated as positive.
262
- 7. Fill the corpus from source corpus order up to 10000 documents.
263
- 8. Remove exact duplicate document text within each split. If a removed duplicate was referenced by qrels, rewrite qrels to the kept document id when the generator records that policy.
264
- 9. Store document title and body as a single `text` field when the source provides both.
265
- 10. Generate BM25 top-100 candidates with the tokenization policy recorded per split.
266
- 11. If a qrels-positive document is missing from the raw BM25 result, insert it into the final `bm25` candidate list by replacing a tail non-positive candidate.
267
 
268
- Some source queries had more positives than the BM25 candidate cap. For those cases, the Nano qrels keep the first available positive document so BM25 top-k remains comparable; 44 selected queries were capped and 4851 source positive qrels were omitted from this Nano slice.
269
 
270
- ## BM25 Subset Policy
271
 
272
- The `bm25` config is a candidate subset for first-stage retrieval and reranking. It is not a separate source dataset. Each row contains one query id and a ranked list of corpus ids.
273
 
274
- BM25 candidates are generated from the selected corpus for each split. The configured candidate cap is top-100. When a qrels-positive document is not present in the raw BM25 result, the missing positive is forced into the final candidate list by replacing a tail candidate that is not positive for that query. Candidate ids are kept unique after replacement.
 
 
 
 
 
 
275
 
276
- ## Split Mapping
277
 
278
- | Nano split | Source task | Source dataset | Queries | Corpus | Qrels |
279
- |---|---|---|---:|---:|---:|
280
- | `NanoBIRCOArguAna` | `BIRCO-ArguAna` | `mteb/BIRCO-ArguAna-Test` | 98 | 3081 | 98 |
281
- | `NanoBIRCOClinicalTrial` | `BIRCO-ClinicalTrial` | `mteb/BIRCO-ClinicalTrial-Test` | 50 | 3375 | 1042 |
282
- | `NanoBIRCODorisMae` | `BIRCO-DorisMae` | `mteb/BIRCO-DorisMae-Test` | 60 | 5544 | 1569 |
283
- | `NanoBIRCORelic` | `BIRCO-Relic` | `mteb/BIRCO-Relic-Test` | 100 | 5023 | 100 |
284
- | `NanoBIRCOWTB` | `BIRCO-WTB` | `mteb/BIRCO-WTB-Test` | 100 | 1766 | 100 |
285
 
286
- ## BM25 nDCG@10
287
 
288
- `nDCG@10` is computed from the included BM25 ranking against the included qrels.
 
 
 
 
 
 
 
289
 
290
- Tokenizer policy summary: `stemmer:en`.
291
 
292
- | Nano split | Tokenizer | Forced BM25 positives | BM25 nDCG@10 |
293
- |---|---|---:|---:|
294
- | `NanoBIRCOArguAna` | `stemmer:en` | 6 | 0.4051 |
295
- | `NanoBIRCOClinicalTrial` | `stemmer:en` | 819 | 0.1194 |
296
- | `NanoBIRCODorisMae` | `stemmer:en` | 942 | 0.2469 |
297
- | `NanoBIRCORelic` | `stemmer:en` | 62 | 0.0633 |
298
- | `NanoBIRCOWTB` | `stemmer:en` | 65 | 0.0751 |
299
 
300
- ## Skipped Tasks
301
 
302
- No source tasks were skipped.
 
 
 
 
 
 
303
 
304
  ## License
305
 
 
145
  download_size: 807492
146
  dataset_size: 803136
147
  configs:
148
+ - config_name: corpus
149
  data_files:
150
  - split: NanoBIRCOArguAna
151
+ path: corpus/NanoBIRCOArguAna.parquet
152
  - split: NanoBIRCOClinicalTrial
153
+ path: corpus/NanoBIRCOClinicalTrial.parquet
154
  - split: NanoBIRCODorisMae
155
+ path: corpus/NanoBIRCODorisMae.parquet
156
  - split: NanoBIRCORelic
157
+ path: corpus/NanoBIRCORelic.parquet
158
  - split: NanoBIRCOWTB
159
+ path: corpus/NanoBIRCOWTB.parquet
160
+ - config_name: queries
161
  data_files:
162
  - split: NanoBIRCOArguAna
163
+ path: queries/NanoBIRCOArguAna.parquet
164
  - split: NanoBIRCOClinicalTrial
165
+ path: queries/NanoBIRCOClinicalTrial.parquet
166
  - split: NanoBIRCODorisMae
167
+ path: queries/NanoBIRCODorisMae.parquet
168
  - split: NanoBIRCORelic
169
+ path: queries/NanoBIRCORelic.parquet
170
  - split: NanoBIRCOWTB
171
+ path: queries/NanoBIRCOWTB.parquet
172
+ default: true
173
+ - config_name: qrels
174
  data_files:
175
  - split: NanoBIRCOArguAna
176
+ path: qrels/NanoBIRCOArguAna.parquet
177
  - split: NanoBIRCOClinicalTrial
178
+ path: qrels/NanoBIRCOClinicalTrial.parquet
179
  - split: NanoBIRCODorisMae
180
+ path: qrels/NanoBIRCODorisMae.parquet
181
  - split: NanoBIRCORelic
182
+ path: qrels/NanoBIRCORelic.parquet
183
  - split: NanoBIRCOWTB
184
+ path: qrels/NanoBIRCOWTB.parquet
185
+ - config_name: bm25
186
  data_files:
187
  - split: NanoBIRCOArguAna
188
+ path: bm25/NanoBIRCOArguAna.parquet
189
  - split: NanoBIRCOClinicalTrial
190
+ path: bm25/NanoBIRCOClinicalTrial.parquet
191
  - split: NanoBIRCODorisMae
192
+ path: bm25/NanoBIRCODorisMae.parquet
193
  - split: NanoBIRCORelic
194
+ path: bm25/NanoBIRCORelic.parquet
195
  - split: NanoBIRCOWTB
196
+ path: bm25/NanoBIRCOWTB.parquet
197
+ - config_name: harrier_oss_v1_270m
198
  data_files:
199
  - split: NanoBIRCOArguAna
200
+ path: harrier_oss_v1_270m/NanoBIRCOArguAna.parquet
201
  - split: NanoBIRCOClinicalTrial
202
+ path: harrier_oss_v1_270m/NanoBIRCOClinicalTrial.parquet
203
  - split: NanoBIRCODorisMae
204
+ path: harrier_oss_v1_270m/NanoBIRCODorisMae.parquet
205
  - split: NanoBIRCORelic
206
+ path: harrier_oss_v1_270m/NanoBIRCORelic.parquet
207
  - split: NanoBIRCOWTB
208
+ path: harrier_oss_v1_270m/NanoBIRCOWTB.parquet
 
209
  - config_name: reranking_hybrid
210
  data_files:
211
  - split: NanoBIRCOArguAna
212
+ path: reranking_hybrid/NanoBIRCOArguAna.parquet
213
  - split: NanoBIRCOClinicalTrial
214
+ path: reranking_hybrid/NanoBIRCOClinicalTrial.parquet
215
  - split: NanoBIRCODorisMae
216
+ path: reranking_hybrid/NanoBIRCODorisMae.parquet
217
  - split: NanoBIRCORelic
218
+ path: reranking_hybrid/NanoBIRCORelic.parquet
219
  - split: NanoBIRCOWTB
220
+ path: reranking_hybrid/NanoBIRCOWTB.parquet
221
+ tags:
222
+ - information-retrieval
223
+ - retrieval
224
+ - nano
225
+ - bm25
226
+ - dense-retrieval
227
+ - reranking
228
+ - hakari-bench
229
  ---
 
230
  # NanoBIRCO
231
 
232
+ This dataset is a Nano-style retrieval dataset for [HAKARI-bench](https://github.com/hakari-bench/hakari-bench).
 
 
233
 
234
  NanoBIRCO contains 5 Nano retrieval splits derived from BIRCO. Each split keeps up to 200 eligible queries and up to 10000 corpus documents, with exact duplicate query and document text removed where the generator records that policy.
235
 
236
+ ## Usage
237
 
238
+ ```python
239
+ from datasets import load_dataset
240
+
241
+ dataset_id = "hakari-bench/NanoBIRCO"
242
+ split = "NanoBIRCOArguAna"
243
+
244
+ queries = load_dataset(dataset_id, "queries", split=split)
245
+ corpus = load_dataset(dataset_id, "corpus", split=split)
246
+ qrels = load_dataset(dataset_id, "qrels", split=split)
247
+ reranking_candidates = load_dataset(dataset_id, "reranking_hybrid", split=split)
248
+ ```
249
 
250
  ## Data Layout
251
 
252
+ This dataset uses six Hugging Face Datasets configs:
253
 
254
  - `corpus`: documents with `_id` and `text`
255
  - `queries`: queries with `_id` and `text`
256
  - `qrels`: positive relevance labels with `query-id` and `corpus-id`
257
  - `bm25`: BM25 candidate lists with `query-id` and `corpus-ids`
258
+ - `harrier_oss_v1_270m`: dense candidate lists from `microsoft/harrier-oss-v1-270m`
259
+ - `reranking_hybrid`: RRF candidate lists built from `bm25` and `harrier_oss_v1_270m`
260
 
261
+ Each config has the same Nano split names.
 
 
262
 
263
+ ## Candidate Construction
264
 
265
+ - `bm25`: local BM25 top-500 with automatic language-aware tokenization. The resolved tokenizer is shown in the Candidate Quality table, for example `wordseg@ja`.
266
+ - `harrier_oss_v1_270m`: dense top-500 from `microsoft/harrier-oss-v1-270m`. In tables this is shown as `Dense`; Dense means `microsoft/harrier-oss-v1-270m` with the `web_search_query` prompt for queries and cosine similarity over normalized embeddings.
267
+ - `reranking_hybrid`: RRF over `bm25` and `harrier_oss_v1_270m` using `rrf_k=100`, keeping the RRF top-100.
 
 
 
 
 
 
 
 
268
 
269
+ Safeguard means rank 101 is appended only when RRF top-100 contains no qrels-positive document.
270
 
271
+ ## Split Statistics
272
 
273
+ Length statistics are character counts computed with `len(str(text))`.
274
 
275
+ | Nano split | Queries | Corpus | Qrels | Query chars avg | Query chars p50 | Query chars p75 | Doc chars avg | Doc chars p50 | Doc chars p75 |
276
+ |---|---:|---:|---:|---:|---:|---:|---:|---:|---:|
277
+ | NanoBIRCOArguAna | 98 | 3081 | 98 | 1124.0 | 1101.5 | 1410.2 | 1140.1 | 1082.0 | 1445.0 |
278
+ | NanoBIRCOClinicalTrial | 50 | 3375 | 1042 | 497.0 | 438.5 | 558.8 | 1174.3 | 1421.0 | 1579.0 |
279
+ | NanoBIRCODorisMae | 60 | 5544 | 1569 | 995.5 | 993.5 | 1095.5 | 1220.3 | 1208.5 | 1431.0 |
280
+ | NanoBIRCORelic | 100 | 5023 | 100 | 1016.3 | 1054.0 | 1144.5 | 477.3 | 438.0 | 627.0 |
281
+ | NanoBIRCOWTB | 100 | 1766 | 100 | 811.3 | 788.5 | 954.8 | 1091.2 | 1108.0 | 1269.8 |
282
 
283
+ ## Candidate Quality
284
 
285
+ `nDCG@10` and `Recall@100` are computed from the included candidate rankings against the included qrels, then reported as 0-100 scores such as `52.45`. `Recall@100` uses only the top 100 candidates; an optional rank-101 safeguard positive is not counted in `Recall@100`.
 
 
 
 
 
 
286
 
287
+ Dense means `microsoft/harrier-oss-v1-270m` with the `web_search_query` prompt and cosine similarity.
288
 
289
+ | Nano split | BM25 tokenizer | BM25 nDCG@10 | Dense nDCG@10 | Hybrid nDCG@10 | BM25 Recall@100 | Dense Recall@100 | Hybrid Recall@100 | Hybrid candidates | Safeguard positives |
290
+ |---|---|---:|---:|---:|---:|---:|---:|---:|---:|
291
+ | Mean | - | 26.93 | 29.59 | 31.11 | 63.53 | 70.96 | 73.38 | - | 66 |
292
+ | NanoBIRCOArguAna | english_porter_stop | 42.93 | 50.62 | 49.32 | 97.96 | 97.96 | 100.00 | 100 | 0 |
293
+ | NanoBIRCOClinicalTrial | english_porter_stop | 13.22 | 21.52 | 19.59 | 31.03 | 48.52 | 45.61 | 100-101 | 1 |
294
+ | NanoBIRCODorisMae | english_porter_stop | 38.66 | 41.40 | 40.12 | 70.68 | 72.34 | 80.30 | 100-101 | 6 |
295
+ | NanoBIRCORelic | english_porter_stop | 13.14 | 7.25 | 12.76 | 59.00 | 66.00 | 69.00 | 100-101 | 31 |
296
+ | NanoBIRCOWTB | english_porter_stop | 26.69 | 27.14 | 33.76 | 59.00 | 70.00 | 72.00 | 100-101 | 28 |
297
 
298
+ ## Hybrid Safeguard Summary
299
 
300
+ - Safeguard positives: 66
301
+ - Rows limited by corpus size: 0
302
+ - Metadata file: `reranking_hybrid_metadata.json`
 
 
 
 
303
 
304
+ ## Source Links
305
 
306
+ - Source benchmark: `BIRCO`
307
+ - Source benchmark repository: https://github.com/embeddings-benchmark/mteb
308
+ - `mteb/BIRCO-ArguAna-Test`: https://huggingface.co/datasets/mteb/BIRCO-ArguAna-Test
309
+ - `mteb/BIRCO-ClinicalTrial-Test`: https://huggingface.co/datasets/mteb/BIRCO-ClinicalTrial-Test
310
+ - `mteb/BIRCO-DorisMae-Test`: https://huggingface.co/datasets/mteb/BIRCO-DorisMae-Test
311
+ - `mteb/BIRCO-Relic-Test`: https://huggingface.co/datasets/mteb/BIRCO-Relic-Test
312
+ - `mteb/BIRCO-WTB-Test`: https://huggingface.co/datasets/mteb/BIRCO-WTB-Test
313
 
314
  ## License
315