Add metadata and link to paper/code

#1
by nielsr HF Staff - opened
Files changed (1) hide show
  1. README.md +20 -35
README.md CHANGED
@@ -1,24 +1,25 @@
1
  ---
2
  license: apache-2.0
 
 
3
  ---
4
 
5
  <div align="center">
6
 
7
- <h1> R1-Router: Learning to Route Queries across Knowledge Bases for Step-wise Retrieval-Augmented Reasoning </h1>
8
 
9
 
10
  <h5 align="center">
11
 
12
  <a href='https://arxiv.org/abs/2505.22095'><img src='https://img.shields.io/badge/Paper-Arxiv-red'></a>
13
- <a href='https://huggingface.co/hmhm1229/R1-Router'><img src='https://img.shields.io/badge/%F0%9F%A4%97%20Hugging%20Face-Models-blue'>
14
- <a href='https://huggingface.co/hmhm1229/R1-Router-3B'><img src='https://img.shields.io/badge/%F0%9F%A4%97%20Hugging%20Face-Models-blue'>
15
 
16
- Chunyi Peng<sup>1,3</sup>,
17
  Zhipeng Xu<sup>1</sup>,
18
  Zhenghao Liu<sup>1</sup>,
19
  Yishan Li<sup>3</sup>,
20
  Yukun Yan<sup>2</sup>,
21
- Zhiyuan Liu<sup>2</sup>,
22
  Yu Gu<sup>1</sup>
23
  Minghe Yu<sup>1</sup>
24
  Ge Yu<sup>1</sup>
@@ -30,8 +31,11 @@ Maosong Sun<sup>2</sup>
30
  </h5>
31
  </div>
32
 
 
 
33
  ## News
34
- 8.22 We upload [R1-Router-3B](https://huggingface.co/hmhm1229/R1-Router-3B).
 
35
 
36
  ## Environment
37
  For training, answer generation, and evaluation processes:
@@ -59,26 +63,9 @@ For the image corpus, you can directly download [M-BEIR](https://huggingface.co/
59
 
60
  For the table corpus, you can download, embed and index Open-WikiTable following the [repository](https://github.com/sean0042/Open_WikiTable), or you can download directly the one we have already preprocessed from [here](https://huggingface.co/hmhm1229/table-retriever).
61
 
62
- ## Retrievers Preparation
63
- For the Text-Image Retriever, you can directly download [UniIR](https://huggingface.co/TIGER-Lab/UniIR)
64
-
65
- For the Table Retriever, you can train it with the help of [repository](https://github.com/sean0042/Open_WikiTable), or you can download it directly from [here](https://huggingface.co/hmhm1229/table-retriever).
66
-
67
- ## Datasets
68
- We have prepared all the text datasets in `./datasets`, for images you need to download them from:
69
- - `InfoSeek:` InfoSeek images can be downloaded from [OVEN](https://github.com/open-vision-language/oven/tree/main/image_downloads)
70
- - `Dyn-VQA:` Dynamic VQA images can be downloaded from [DynVQA_en.202412](https://github.com/Alibaba-NLP/OmniSearch/blob/main/dataset/DynVQA_en/DynVQA_en.202412.jsonl)
71
- - `WebQA:` WebQA images can be downloaded from [Google Drive](https://drive.google.com/drive/folders/19ApkbD5w0I5sV1IeQ9EofJRyAjKnA7tb)
72
-
73
  ## Training
74
- If you do not want to train the model, you can download [R1-Router](https://huggingface.co/hmhm1229/R1-Router) and skip this section to [Evaluation](#evaluation)
75
- ### Data Synthesis
76
- If you want to use the ready-to-use synthetic data directly, you can skip this section to [Step-GRPO Training](#step-grpo-training)
77
 
78
- First, we need to synthesis the data step by step:
79
- ```bash
80
- bash src/data_synthesis/data_synthesis.sh
81
- ```
82
  ### Step-GRPO Training
83
  Our training framework is based on [EasyR1](https://github.com/hiyouga/EasyR1), only you need to do is to download it and replace some files with the files in `./Easy-R1`.
84
  Then start training with the command:
@@ -86,6 +73,7 @@ Then start training with the command:
86
  conda activate router
87
  bash examples/run_qwen2_5_vl_7b_stepgrpo.sh
88
  ```
 
89
  ## Evaluation
90
  We provide the evaluation pipeline for the R1-Router:
91
  ```bash
@@ -106,19 +94,16 @@ Our work is built on the following codebases, and we are deeply grateful for the
106
  - [OmniSearch](https://github.com/Alibaba-NLP/OmniSearch)
107
 
108
  ## Citation
109
- We appreciate your citations if you find our paper related and useful to your research!
110
- ```
111
- @article{peng2025r1,
112
- title={Learning to Route Queries across Knowledge Bases for Step-wise Retrieval-Augmented Reasoning},
113
- author={Peng, Chunyi and Xu, Zhipeng and Liu, Zhenghao and Li, Yishan and Yan, Yukun and Wang, Shuo and Liu, Zhiyuan and Gu, Yu and Yu, Minghe and Yu, Ge and Sun, Maosong},
114
- year={2025}
115
- url={https://arxiv.org/abs/2505.22095},
116
  }
117
  ```
118
 
119
  ## Contact Us
120
  If you have questions, suggestions, and bug reports, please email us, we will try our best to help you.
121
- ```
122
- hm.cypeng@gmail.com
123
- ```
124
-
 
1
  ---
2
  license: apache-2.0
3
+ library_name: transformers
4
+ pipeline_tag: image-text-to-text
5
  ---
6
 
7
  <div align="center">
8
 
9
+ <h1> MoRE: Mixture-of-Retrieval Experts for Reasoning-Guided Multimodal Knowledge Exploitation </h1>
10
 
11
 
12
  <h5 align="center">
13
 
14
  <a href='https://arxiv.org/abs/2505.22095'><img src='https://img.shields.io/badge/Paper-Arxiv-red'></a>
15
+ <a href='https://huggingface.co/hmhm1229/R1-Router-3B'><img src='https://img.shields.io/badge/%F0%9F%A4%97%20Hugging%20Face-Models-blue'></a>
16
+ <a href='https://github.com/OpenBMB/R1-Router'><img src='https://img.shields.io/badge/GitHub-Code-black'></a>
17
 
18
+ Chunyi Peng<sup>1</sup>,
19
  Zhipeng Xu<sup>1</sup>,
20
  Zhenghao Liu<sup>1</sup>,
21
  Yishan Li<sup>3</sup>,
22
  Yukun Yan<sup>2</sup>,
 
23
  Yu Gu<sup>1</sup>
24
  Minghe Yu<sup>1</sup>
25
  Ge Yu<sup>1</sup>
 
31
  </h5>
32
  </div>
33
 
34
+ **MoRE** (Mixture-of-Retrieval Experts) is a novel framework that enables Multimodal Large Language Models (MLLMs) to collaboratively interact with diverse retrieval experts for more effective knowledge exploitation. This repository contains the **3B** version of the R1-Router, which was trained using Stepwise Group Relative Policy Optimization (Step-GRPO) to dynamically coordinate heterogeneous experts.
35
+
36
  ## News
37
+ * **2026.04.03**: Our work is accepted by SIGIR2026 ๐ŸŽ‰๐ŸŽ‰๐ŸŽ‰!
38
+ * **2025.08.22**: We upload [MoRE-3B](https://huggingface.co/hmhm1229/R1-Router-3B).
39
 
40
  ## Environment
41
  For training, answer generation, and evaluation processes:
 
63
 
64
  For the table corpus, you can download, embed and index Open-WikiTable following the [repository](https://github.com/sean0042/Open_WikiTable), or you can download directly the one we have already preprocessed from [here](https://huggingface.co/hmhm1229/table-retriever).
65
 
 
 
 
 
 
 
 
 
 
 
 
66
  ## Training
67
+ If you do not want to train the model, you can use this checkpoint and skip to [Evaluation](#evaluation).
 
 
68
 
 
 
 
 
69
  ### Step-GRPO Training
70
  Our training framework is based on [EasyR1](https://github.com/hiyouga/EasyR1), only you need to do is to download it and replace some files with the files in `./Easy-R1`.
71
  Then start training with the command:
 
73
  conda activate router
74
  bash examples/run_qwen2_5_vl_7b_stepgrpo.sh
75
  ```
76
+
77
  ## Evaluation
78
  We provide the evaluation pipeline for the R1-Router:
79
  ```bash
 
94
  - [OmniSearch](https://github.com/Alibaba-NLP/OmniSearch)
95
 
96
  ## Citation
97
+ We appreciate your citations if you find our paper relevant and useful to your research!
98
+ ```bibtex
99
+ @article{peng2025mixture,
100
+ title={Mixture-of-Retrieval Experts for Reasoning-Guided Multimodal Knowledge Exploitation},
101
+ author={Peng, Chunyi and Xu, Zhipeng and Liu, Zhenghao and Li, Yishan and Yan, Yukun and Wang, Shuo and Gu, Yu and Yu, Minghe and Yu, Ge and Sun, Maosong},
102
+ year={2025},
103
+ url={https://arxiv.org/abs/2505.22095}
104
  }
105
  ```
106
 
107
  ## Contact Us
108
  If you have questions, suggestions, and bug reports, please email us, we will try our best to help you.
109
+ `hm.cypeng@gmail.com`