Update README.md

README.md

@@ -1,13 +1,23 @@
 ---
 library_name: transformers
-tags: []
+tags:
+- Reasoning
+- Retrieval
+license: mit
+datasets:
+- Raderspace/MATH_qCoT_LLMquery_lexicalquery
+language:
+- en
+base_model:
+- Qwen/Qwen2.5-7B-Instruct
 ---
 
+
 # Model Card for Model ID
 
 <!-- Provide a quick summary of what the model is/does. -->
-
-
+RaDeR, are a set of reasoning-based dense retrieval and reranker models trained with data derived from mathematical problem solving using large language models (LLMs).
+RaDeR retrievers, trained for mathematical reasoning, effectively generalize to diverse retrieval reasoning tasks in the BRIGHT and RAR-b benchmarks, consistently outperforming strong baselines in overall performance.
 
 ## Model Details
 
@@ -17,156 +27,50 @@ tags: []
 
 This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
 
-- **Developed by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
+- **Developed by:** CIIR, UMass Amherst
+- **Model type:** Retriever
+- **Language(s):** English
+- **License:** MIT
+- **Finetuned from model:** Qwen-2.5-7B-Instruct
 
-### Model Sources [optional]
+### Model Sources
 
 <!-- Provide the basic links for the model. -->
 
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
-
-## Uses
-
-<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
-
-### Direct Use
-
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
-
-[More Information Needed]
-
-### Downstream Use [optional]
-
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
-
-[More Information Needed]
-
-### Out-of-Scope Use
-
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
-
-[More Information Needed]
-
-## Bias, Risks, and Limitations
-
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-
-[More Information Needed]
+- **Repository:** https://github.com/Debrup-61/RaDeR
+- **Paper** https://huggingface.co/papers/2505.18405
 
-### Recommendations
-
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
-
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
 
 ## How to Get Started with the Model
 
-Use the code below to get started with the model.
+Run the following code to start a server of the model with **vLLM** for fast inference. 
+
+```
+vllm serve Raderspace/RaDeR_Qwen_25_7B_instruct_MATH_LLMq_CoT_lexical \
+  --task embed \
+  --trust-remote-code \
+  --override-pooler-config '{"pooling_type": "LAST", "normalize": true}' \
+  --gpu-memory-utilization 0.9 \
+  --api-key abc \
+  --tokenizer Qwen/Qwen2.5-7B-Instruct \
+  --port 8001 \
+  --disable-log-requests \
+  --max-num-seqs 5000
+```
 
-[More Information Needed]
+Follow the code on [Github](https://github.com/Debrup-61/RaDeR/blob/main/models/RaDeR_retriever_server_API.py) to see how to query the retriever server. 
 
 ## Training Details
 
 ### Training Data
 
 <!-- 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. -->
+The model was trained using the [MATH](https://huggingface.co/datasets/Raderspace/MATH_qCoT_LLMquery_lexicalquery) retrieval training dataset from RaDeR, containing CoT, LLMq and lexical query types.  
 
-[More Information Needed]
-
-### Training Procedure
-
-<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
-
-#### Preprocessing [optional]
-
-[More Information Needed]
-
-
-#### Training Hyperparameters
-
-- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
-
-#### Speeds, Sizes, Times [optional]
-
-<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
-
-[More Information Needed]
-
-## Evaluation
-
-<!-- This section describes the evaluation protocols and provides the results. -->
-
-### Testing Data, Factors & Metrics
-
-#### Testing Data
 
-<!-- This should link to a Dataset Card if possible. -->
-
-[More Information Needed]
-
-#### Factors
-
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
-
-[More Information Needed]
-
-#### Metrics
-
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
-
-[More Information Needed]
-
-### Results
-
-[More Information Needed]
-
-#### Summary
-
-
-
-## Model Examination [optional]
-
-<!-- Relevant interpretability work for the model goes here -->
-
-[More Information Needed]
-
-## Environmental Impact
-
-<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
-
-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).
-
-- **Hardware Type:** [More Information Needed]
-- **Hours used:** [More Information Needed]
-- **Cloud Provider:** [More Information Needed]
-- **Compute Region:** [More Information Needed]
-- **Carbon Emitted:** [More Information Needed]
-
-## Technical Specifications [optional]
-
-### Model Architecture and Objective
-
-[More Information Needed]
-
-### Compute Infrastructure
-
-[More Information Needed]
-
-#### Hardware
-
-[More Information Needed]
 
 #### Software
-
-[More Information Needed]
+https://github.com/Debrup-61/RaDeR
 
 ## Citation [optional]
 
@@ -174,26 +78,20 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
 
 **BibTeX:**
 
-[More Information Needed]
-
-**APA:**
-
-[More Information Needed]
-
-## Glossary [optional]
+@misc{das2025raderreasoningawaredenseretrieval,
+      title={RaDeR: Reasoning-aware Dense Retrieval Models}, 
+      author={Debrup Das and Sam O' Nuallain and Razieh Rahimi},
+      year={2025},
+      eprint={2505.18405},
+      archivePrefix={arXiv},
+      primaryClass={cs.CL},
+      url={https://arxiv.org/abs/2505.18405}, 
+}
 
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
 
-[More Information Needed]
-
-## More Information [optional]
-
-[More Information Needed]
+## Model Card Contact
 
-## Model Card Authors [optional]
+Debrup Das: [email protected]
 
-[More Information Needed]
 
-## Model Card Contact
 
-[More Information Needed]