emrekuruu commited on
Commit
21cd1b8
·
verified ·
1 Parent(s): 4c6c143

Add baseline model card

Browse files
Files changed (1) hide show
  1. README.md +113 -195
README.md CHANGED
@@ -1,199 +1,117 @@
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
+ - baseline
20
+ datasets:
21
+ - emrekuruu/FinReport
22
+ - emrekuruu/FinSlides
23
+ - emrekuruu/FinQA
24
+ - emrekuruu/ConvFinQA
25
+ - emrekuruu/VQAonBD
26
+ - emrekuruu/TATDQA
27
+ - emrekuruu/ArxivQA
28
+ - emrekuruu/Wiki-ss
29
+ - emrekuruu/MP-DocVQA
30
+ - emrekuruu/SciQAG
31
+ - emrekuruu/DUDE
32
+ metrics:
33
+ - ndcg
34
  ---
35
 
36
+ # RetrievalRouter Strategy-Selection Baseline
37
+
38
+ Adaptive routing **baseline** from **RetrievalRouter: Joint Modality and Architecture Selection
39
+ for Document Retrieval** (EMNLP 2026). This is **not** the RetrievalRouter method — it is the
40
+ prior strategy-selection approach of
41
+ [Arabzadeh et al. (2021)](https://dl.acm.org/doi/10.1145/3459637.3482119), extended to our
42
+ five-pipeline setting and trained under an identical pipeline for a controlled comparison.
43
+
44
+ - 📄 Paper: https://arxiv.org/pdf/2608.23176
45
+ - 💻 Code: https://github.com/emrekuruu/retrieval-router
46
+ - 🤗 RetrievalRouter checkpoints: https://huggingface.co/collections/emrekuruu/retrieval-router
47
+
48
+ ## Motivation
49
+
50
+ Retrieval pipelines differ in **modality** (search over text, or over page images) and
51
+ **architecture** (cheap dense search, or expensive late-interaction). The accurate ones are
52
+ slow; the fast ones miss evidence on hard documents. And which one fails depends on the query —
53
+ a text pipeline can't answer "what's the red curve in Figure 3?", but a multimodal one is
54
+ overkill for a plain factoid. Across 11 benchmarks, **no single pipeline wins on everything**.
55
+ RetrievalRouter picks the cheapest pipeline that can still answer each query, so easy queries
56
+ stay fast and hard ones still get the heavy pipeline.
57
+
58
+ ## What this model is for
59
+
60
+ A **research baseline**, provided to reproduce the paper's comparisons. It trains a **hard-label
61
+ classifier**: each query is labeled with the cheapest pipeline that ranks a relevant page first
62
+ (BM25 when none do); at inference a probability threshold decides whether the query stays on BM25
63
+ or escalates to the top-scoring neural pipeline. It differs from RetrievalRouter only in the
64
+ **training signal** hard labels + cross-entropy here, versus a soft reward vector + KL for
65
+ RetrievalRouter. Everything else (encoder, LoRA, pooling, head, split, optimizer, schedule) is
66
+ shared, so any difference reflects the training signal alone. For deployment, prefer the
67
+ [RetrievalRouter checkpoints](https://huggingface.co/collections/emrekuruu/retrieval-router),
68
+ which dominate this baseline on the accuracy–latency frontier.
69
+
70
+ ## Routing arms
71
+
72
+ | Index | Arm (config name) | Paper name | Modality | Architecture |
73
+ |---|---|---|---|---|
74
+ | 0 | `MULTIMODAL_RERANK` | MM-Rerank | Multimodal | Dense → late-interaction rerank |
75
+ | 1 | `MULTIMODAL-SINGLE` | MM-Dense | Multimodal | Single-vector dense |
76
+ | 2 | `TEXT_RERANK` | Text-Rerank | Text | Dense → late-interaction rerank |
77
+ | 3 | `TEXT-SINGLE` | Text-Dense | Text | Single-vector dense |
78
+ | 4 | `BM25` | BM25 | Text | Lexical |
79
+
80
+ ## Architecture
81
+
82
+ Identical to the RetrievalRouter checkpoints:
83
+ [Qwen/Qwen3-0.6B-Base](https://huggingface.co/Qwen/Qwen3-0.6B-Base) encoder + LoRA (merged), mean
84
+ pooling 1024-d, single linear head over the five arms. Custom modeling code loads via
85
+ `trust_remote_code=True`.
86
+
87
+ ## Usage
88
+
89
+ ```python
90
+ import torch
91
+ from transformers import AutoModel, AutoTokenizer
92
+
93
+ repo = "emrekuruu/RetrievalRouter_Baseline"
94
+ tokenizer = AutoTokenizer.from_pretrained(repo, trust_remote_code=True)
95
+ model = AutoModel.from_pretrained(repo, trust_remote_code=True).eval()
96
+
97
+ inputs = tokenizer("In figure 3, what does the red dashed curve represent?",
98
+ return_tensors="pt", truncation=True, max_length=128)
99
+ with torch.no_grad():
100
+ logits = model(**inputs)["logits"] # shape [1, 5]
101
+ arm = model.config.strategy_names[logits.softmax(-1).argmax(-1).item()]
102
+ print(arm) # e.g. "MULTIMODAL_RERANK" -> run that pipeline for this query
103
+ ```
104
+
105
+ The router returns **which retrieval pipeline to run**, not documents. You then execute the
106
+ selected pipeline against your own indices.
107
+
108
+ ## Citation
109
+
110
+ ```bibtex
111
+ @inproceedings{kuru2026retrievalrouter,
112
+ title = {RetrievalRouter: Joint Modality and Architecture Selection for Document Retrieval},
113
+ author = {Kuru, Emre and Keskin, Mehmet Onur and Farahbakhsh, Reza and Crespi, Noel},
114
+ booktitle = {Proceedings of EMNLP 2026},
115
+ year = {2026}
116
+ }
117
+ ```