emrekuruu commited on
Commit
71f3b44
·
verified ·
1 Parent(s): dc28b0e

Add model card

Browse files
Files changed (1) hide show
  1. README.md +125 -169
README.md CHANGED
@@ -1,199 +1,155 @@
1
  ---
 
 
 
 
 
2
  library_name: transformers
3
- tags: []
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
4
  ---
5
 
6
- # Model Card for Model ID
7
 
8
- <!-- Provide a quick summary of what the model is/does. -->
 
 
 
9
 
 
 
 
10
 
 
11
 
12
- ## Model Details
 
 
 
 
 
 
13
 
14
- ### Model Description
15
 
16
- <!-- Provide a longer summary of what this model is. -->
 
 
17
 
18
- This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
 
 
19
 
20
- - **Developed by:** [More Information Needed]
21
- - **Funded by [optional]:** [More Information Needed]
22
- - **Shared by [optional]:** [More Information Needed]
23
- - **Model type:** [More Information Needed]
24
- - **Language(s) (NLP):** [More Information Needed]
25
- - **License:** [More Information Needed]
26
- - **Finetuned from model [optional]:** [More Information Needed]
27
 
28
- ### Model Sources [optional]
29
 
30
- <!-- Provide the basic links for the model. -->
31
 
32
- - **Repository:** [More Information Needed]
33
- - **Paper [optional]:** [More Information Needed]
34
- - **Demo [optional]:** [More Information Needed]
 
 
 
 
 
35
 
36
- ## Uses
37
 
38
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
 
 
 
 
 
 
39
 
40
- ### Direct Use
 
41
 
42
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
43
 
44
- [More Information Needed]
 
 
 
 
45
 
46
- ### Downstream Use [optional]
47
 
48
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
 
 
49
 
50
- [More Information Needed]
 
 
51
 
52
- ### Out-of-Scope Use
 
 
 
 
 
 
53
 
54
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
 
55
 
56
- [More Information Needed]
57
 
58
- ## Bias, Risks, and Limitations
 
 
59
 
60
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
61
 
62
- [More Information Needed]
 
 
 
 
 
 
 
 
 
 
 
63
 
64
- ### Recommendations
65
-
66
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
67
-
68
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
69
-
70
- ## How to Get Started with the Model
71
-
72
- Use the code below to get started with the model.
73
-
74
- [More Information Needed]
75
-
76
- ## Training Details
77
-
78
- ### Training Data
79
-
80
- <!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
81
-
82
- [More Information Needed]
83
-
84
- ### Training Procedure
85
-
86
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
87
-
88
- #### Preprocessing [optional]
89
-
90
- [More Information Needed]
91
-
92
-
93
- #### Training Hyperparameters
94
-
95
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
96
-
97
- #### Speeds, Sizes, Times [optional]
98
-
99
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
100
-
101
- [More Information Needed]
102
-
103
- ## Evaluation
104
-
105
- <!-- This section describes the evaluation protocols and provides the results. -->
106
-
107
- ### Testing Data, Factors & Metrics
108
-
109
- #### Testing Data
110
-
111
- <!-- This should link to a Dataset Card if possible. -->
112
-
113
- [More Information Needed]
114
-
115
- #### Factors
116
-
117
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
118
-
119
- [More Information Needed]
120
-
121
- #### Metrics
122
-
123
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
124
-
125
- [More Information Needed]
126
-
127
- ### Results
128
-
129
- [More Information Needed]
130
-
131
- #### Summary
132
-
133
-
134
-
135
- ## Model Examination [optional]
136
-
137
- <!-- Relevant interpretability work for the model goes here -->
138
-
139
- [More Information Needed]
140
-
141
- ## Environmental Impact
142
-
143
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
144
-
145
- Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
146
-
147
- - **Hardware Type:** [More Information Needed]
148
- - **Hours used:** [More Information Needed]
149
- - **Cloud Provider:** [More Information Needed]
150
- - **Compute Region:** [More Information Needed]
151
- - **Carbon Emitted:** [More Information Needed]
152
-
153
- ## Technical Specifications [optional]
154
-
155
- ### Model Architecture and Objective
156
-
157
- [More Information Needed]
158
-
159
- ### Compute Infrastructure
160
-
161
- [More Information Needed]
162
-
163
- #### Hardware
164
-
165
- [More Information Needed]
166
-
167
- #### Software
168
-
169
- [More Information Needed]
170
-
171
- ## Citation [optional]
172
-
173
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
174
-
175
- **BibTeX:**
176
-
177
- [More Information Needed]
178
-
179
- **APA:**
180
-
181
- [More Information Needed]
182
-
183
- ## Glossary [optional]
184
-
185
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
186
-
187
- [More Information Needed]
188
-
189
- ## More Information [optional]
190
-
191
- [More Information Needed]
192
-
193
- ## Model Card Authors [optional]
194
-
195
- [More Information Needed]
196
-
197
- ## Model Card Contact
198
-
199
- [More Information Needed]
 
1
  ---
2
+ license: mit
3
+ language:
4
+ - en
5
+ base_model:
6
+ - Qwen/Qwen3-0.6B-Base
7
  library_name: transformers
8
+ pipeline_tag: text-classification
9
+ tags:
10
+ - retrieval
11
+ - document-retrieval
12
+ - information-retrieval
13
+ - routing
14
+ - RAG
15
+ - query-routing
16
+ - late-interaction
17
+ - lora
18
+ - peft
19
+ datasets:
20
+ - emrekuruu/FinReport
21
+ - emrekuruu/FinSlides
22
+ - emrekuruu/FinQA
23
+ - emrekuruu/ConvFinQA
24
+ - emrekuruu/VQAonBD
25
+ - emrekuruu/TATDQA
26
+ - emrekuruu/ArxivQA
27
+ - emrekuruu/Wiki-ss
28
+ - emrekuruu/MP-DocVQA
29
+ - emrekuruu/SciQAG
30
+ - emrekuruu/DUDE
31
+ metrics:
32
+ - ndcg
33
  ---
34
 
35
+ # RetrievalRouter (λ=0.3)
36
 
37
+ Official checkpoint from **RetrievalRouter: Joint Modality and Architecture Selection for
38
+ Document Retrieval** (EMNLP 2026). Given only the **query text**, RetrievalRouter predicts
39
+ *which retrieval pipeline* — across **modality** (text vs. multimodal) and **architecture**
40
+ (lexical, dense, or late-interaction rerank) — to run for that query.
41
 
42
+ - 📄 Paper: https://arxiv.org/pdf/2608.23176
43
+ - 💻 Code: https://github.com/emrekuruu/retrieval-router
44
+ - 🤗 Collection (all checkpoints + datasets): https://huggingface.co/collections/emrekuruu/retrieval-router
45
 
46
+ ## Motivation
47
 
48
+ Retrieval pipelines differ in **modality** (search over text, or over page images) and
49
+ **architecture** (cheap dense search, or expensive late-interaction). The accurate ones are
50
+ slow; the fast ones miss evidence on hard documents. And which one fails depends on the query —
51
+ a text pipeline can't answer "what's the red curve in Figure 3?", but a multimodal one is
52
+ overkill for a plain factoid. Across 11 benchmarks, **no single pipeline wins on everything**.
53
+ RetrievalRouter picks the cheapest pipeline that can still answer each query, so easy queries
54
+ stay fast and hard ones still get the heavy pipeline.
55
 
56
+ ## What this model is for
57
 
58
+ This is a **router, not a retriever**. It takes a query and predicts which of five retrieval
59
+ pipelines to run — in about 15 ms, before any search happens. You then run the chosen pipeline
60
+ to fetch documents.
61
 
62
+ Use it when you keep several retrieval setups over the same corpus and want to run the expensive
63
+ ones only when they help. Pick the checkpoint by **λ**: `0.0` for best accuracy, `1.0` for best
64
+ speed, in between to trade off.
65
 
66
+ It doesn't rank or read documents itself, and assumes your indices already exist. Trained on
67
+ English financial, scientific, and open-domain documents; other domains and languages are
68
+ untested.
 
 
 
 
69
 
70
+ ## This checkpoint
71
 
72
+ **Trained with λ=0.3** a **balanced** objective (λ=0.3), trading a controlled amount of accuracy for lower latency between the quality-only (λ=0.0) and latency-only (λ=1.0) endpoints.
73
 
74
+ | Checkpoint | λ | Objective |
75
+ |---|---|---|
76
+ | [`RetrievalRouter-lambda-l00`](https://huggingface.co/emrekuruu/RetrievalRouter-lambda-l00) | 0.0 | Accuracy only |
77
+ | [`RetrievalRouter-lambda-l10`](https://huggingface.co/emrekuruu/RetrievalRouter-lambda-l10) | 0.1 | Accuracy-leaning |
78
+ | [`RetrievalRouter-lambda-l30`](https://huggingface.co/emrekuruu/RetrievalRouter-lambda-l30) | 0.3 | Balanced |
79
+ | [`RetrievalRouter-lambda-l50`](https://huggingface.co/emrekuruu/RetrievalRouter-lambda-l50) | 0.5 | Balanced |
80
+ | [`RetrievalRouter-lambda-l70`](https://huggingface.co/emrekuruu/RetrievalRouter-lambda-l70) | 0.7 | Latency-leaning |
81
+ | [`RetrievalRouter-lambda-l100`](https://huggingface.co/emrekuruu/RetrievalRouter-lambda-l100) | 1.0 | Latency only |
82
 
83
+ ## Routing arms
84
 
85
+ | Index | Arm (config name) | Paper name | Modality | Architecture |
86
+ |---|---|---|---|---|
87
+ | 0 | `MULTIMODAL_RERANK` | MM-Rerank | Multimodal | Dense → late-interaction rerank |
88
+ | 1 | `MULTIMODAL-SINGLE` | MM-Dense | Multimodal | Single-vector dense |
89
+ | 2 | `TEXT_RERANK` | Text-Rerank | Text | Dense → late-interaction rerank |
90
+ | 3 | `TEXT-SINGLE` | Text-Dense | Text | Single-vector dense |
91
+ | 4 | `BM25` | BM25 | Text | Lexical |
92
 
93
+ The action space is these five arms. Two further pipelines evaluated in the paper (Text-Late,
94
+ MM-Late) are reported as static reference baselines but never routed to.
95
 
96
+ ## Architecture
97
 
98
+ - **Encoder:** [Qwen/Qwen3-0.6B-Base](https://huggingface.co/Qwen/Qwen3-0.6B-Base) with LoRA
99
+ adapters on the attention and feed-forward projections (merged into these weights).
100
+ - **Pooling:** mean-pool over the final hidden states → a 1024-d query representation.
101
+ - **Head:** a single linear layer → logits over the five arms; softmax gives the routing policy.
102
+ - Custom modeling code ships in the repo and loads via `trust_remote_code=True`.
103
 
104
+ ## Usage
105
 
106
+ ```python
107
+ import torch
108
+ from transformers import AutoModel, AutoTokenizer
109
 
110
+ repo = "emrekuruu/RetrievalRouter-lambda-l30"
111
+ tokenizer = AutoTokenizer.from_pretrained(repo, trust_remote_code=True)
112
+ model = AutoModel.from_pretrained(repo, trust_remote_code=True).eval()
113
 
114
+ inputs = tokenizer("In figure 3, what does the red dashed curve represent?",
115
+ return_tensors="pt", truncation=True, max_length=128)
116
+ with torch.no_grad():
117
+ logits = model(**inputs)["logits"] # shape [1, 5]
118
+ arm = model.config.strategy_names[logits.softmax(-1).argmax(-1).item()]
119
+ print(arm) # e.g. "MULTIMODAL_RERANK" -> run that pipeline for this query
120
+ ```
121
 
122
+ The router returns **which retrieval pipeline to run**, not documents. You then execute the
123
+ selected pipeline against your own indices.
124
 
125
+ ## Training
126
 
127
+ Trained against **soft targets** from a per-query reward vector over the five arms, rather than a
128
+ single hard best-pipeline label (pipelines frequently tie on nDCG@5, and hard labels inject
129
+ noise). The reward combines accuracy and efficiency,
130
 
131
+ $$ r_i(q) = (1-\lambda)\, s_i(q) + \lambda\,(1 - \ell_i(q)), $$
132
 
133
+ where $s_i(q)$ is the arm's nDCG@5 and $\ell_i(q)$ its per-query normalized latency. The reward
134
+ vector becomes a target distribution via a low-temperature softmax (τ=0.1), and the router
135
+ minimizes the KL divergence to it. **λ is the only knob** that differs across the checkpoints
136
+ above. Training data spans **85,103 queries across 11 benchmarks**.
137
+
138
+ ## Results (headline)
139
+
140
+ Against the strongest static pipeline, RetrievalRouter is **+2.5% nDCG@5 and 12.4× faster**.
141
+ Against the prior adaptive strategy-selection baseline
142
+ ([`emrekuruu/Baseline`](https://huggingface.co/emrekuruu/Baseline)), it achieves significantly
143
+ higher nDCG@5 in accuracy-oriented settings and matches or numerically beats it on both nDCG@5
144
+ and latency in latency-oriented settings. See the paper for full tables and significance tests.
145
 
146
+ ## Citation
147
+
148
+ ```bibtex
149
+ @inproceedings{kuru2026retrievalrouter,
150
+ title = {RetrievalRouter: Joint Modality and Architecture Selection for Document Retrieval},
151
+ author = {Kuru, Emre and Keskin, Mehmet Onur and Farahbakhsh, Reza and Crespi, Noel},
152
+ booktitle = {Proceedings of EMNLP 2026},
153
+ year = {2026}
154
+ }
155
+ ```