Update README.md

README.md

@@ -1,46 +1,202 @@
 ---
 library_name: transformers
-license: mit
-language:
-- en
-base_model:
-- meta-llama/Llama-3.1-8B-Instruct
 pipeline_tag: text-generation
-datasets:
-- HINT-lab/Llama_3.1-8B-Instruct-Self-Calibration
+license: apache-2.0
+tags:
+  - self-calibration
+  - efficient-sampling
+  - llm-uncertainty
 ---
 
-# Model Card for Model ID
+# Model Card for Efficient Test-Time Scaling via Self-Calibration
 
-Model trained based on `meta-llama/Llama-3.1-8B-Instruct` by Self-Calibration proposed by [Efficient Test-Time Scaling via Self-Calibration](https://arxiv.org/abs/2503.00031). 
 
 
-## Model Sources
 
-<!-- Provide the basic links for the model. -->
+This model implements an efficient test-time scaling method using model confidence for dynamic sampling adjustment. It addresses the challenge of overconfidence in LLMs by introducing a self-calibration framework that generates calibrated confidence scores, improving computational efficiency without sacrificing accuracy. This is based on the research paper [Efficient Test-Time Scaling via Self-Calibration](https://arxiv.org/abs/2503.00031).
 
-- **Repository:** https://github.com/Chengsong-Huang/Self-Calibration
-- **Paper :** Efficient Test-Time Scaling via Self-Calibration
+## Model Details
 
+### Model Description
 
+This model uses model confidence to dynamically adjust sampling during inference, leading to significant improvements in computational efficiency. The self-calibration framework ensures calibrated confidence scores, making the method robust and reliable. The model is designed to work with various sampling methods, including early exit, ascending confidence, self-consistency, and best-of-N.
+
+
+
+- **Developed by:** HINT-lab
+- **Model type:** Large Language Model (LLM)
+- **Language(s) (NLP):** English (supports other languages depending on the base model used during training)
+- **License:** Apache 2.0
+- **Finetuned from model [optional]:** (Specify base model used, e.g., `meta-llama/Llama-3.1-8B-Instruct`)
+
+
+
+### Model Sources [optional]
+
+- **Repository:** [https://github.com/HINT-lab/Self-Calibration](https://github.com/HINT-lab/Self-Calibration)
+- **Paper [optional]:** [https://arxiv.org/abs/2503.00031](https://arxiv.org/abs/2503.00031)
+- **Models:**
+  - [DeepSeek-R1-Distill-Qwen-1.5B-Self-Calibration](https://huggingface.co/HINT-lab/DeepSeek-R1-Distill-Qwen-1.5B-Self-Calibration)
+  - [Qwen2.5-7B-Instruct-Self-Calibration](https://huggingface.co/HINT-lab/Qwen2.5-7B-Instruct-Self-Calibration)
+  - [Llama-3.1-8B-Instruct-Self-Calibration](https://huggingface.co/HINT-lab/Llama-3.1-8B-Instruct-Self-Calibration)
+- **Datasets:**
+  - [DeepSeek-R1-Distill-Qwen-1.5B](https://huggingface.co/datasets/HINT-lab/DeepSeek-R1-Distill-Qwen-1.5B-Self-Calibration)
+  - [Qwen2.5-7B-Instruct](https://huggingface.co/datasets/HINT-lab/Qwen2.5-7B-Instruct-Self-Calibration)
+  - [Llama_3.1-8B-Instruct](https://huggingface.co/datasets/HINT-lab/Llama_3.1-8B-Instruct-Self-Calibration)
+
+## Uses
+
+
+
+### Direct Use
+
+The model can be used directly for text generation tasks with various sampling methods. The user can specify the desired sampling method, confidence threshold (if applicable), number of samples, and temperature.
+
+
+
+### Downstream Use [optional]
+
+The model can be fine-tuned for specific downstream tasks or integrated into larger applications requiring efficient text generation.
+
+
+
+### Out-of-Scope Use
+
+The model may not perform well on tasks requiring high creativity or those outside the domains represented in the training data. The accuracy of the confidence scores depends heavily on the quality and calibration of the underlying base LLM.
+
+
+
+## Bias, Risks, and Limitations
+
+The model inherits biases from its base LLM. The accuracy of the confidence scores and the effectiveness of the sampling methods may vary depending on the task and the base model. Over-reliance on the model's confidence scores without considering other factors could lead to incorrect inferences.
+
+
+
+### Recommendations
+
+Users should be aware of potential biases and limitations. It's recommended to evaluate the model's performance on specific tasks before deploying it to critical applications. Users should also critically evaluate the confidence scores provided by the model.
+
+
+
+## How to Get Started with the Model
+
+See the "Quickstart" section in the Github README for instructions on how to install the necessary packages and use the model for inference.
+
+
+
+## Training Details
+
+### Training Data
+
+The training data consists of datasets created by generating multiple responses to prompts from various benchmark datasets (more detail can be found in the Github README).
+
+
+
+### Training Procedure
+
+The training procedure involves a self-calibration process to improve the model's ability to generate calibrated confidence scores. Details are in the Github README.
+
+
+
+
+
+
+#### Training Hyperparameters
+
+(To be added from Github README - `model_training/configs/{version}.json`)
+
+#### Speeds, Sizes, Times [optional]
+
+(To be added from Github README - training times on various hardware)
+
+
+
+## Evaluation
+
+(To be added from Github README - evaluation protocols and results)
+
+### Testing Data, Factors & Metrics
+
+(To be added from Github README)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+### Results
+
+(To be added from Github README)
+
+#### Summary
+
+(To be added from Github README)
+
+
+
+
+
+
+
+## Environmental Impact
+
+(To be added based on hardware usage reported in the Github README)
+
+
+
+
+
+
+
+
+
+## Technical Specifications [optional]
+
+(To be added based on model architecture and training details in the Github README)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Citation [optional]
 
-## Citation
 
-<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
 
 **BibTeX:**
-```
+
+```bibtex
 @misc{huang2025efficienttesttimescalingselfcalibration,
-      title={Efficient Test-Time Scaling via Self-Calibration}, 
+      title={Efficient Test-Time Scaling via Self-Calibration},
       author={Chengsong Huang and Langlin Huang and Jixuan Leng and Jiacheng Liu and Jiaxin Huang},
       year={2025},
       eprint={2503.00031},
       archivePrefix={arXiv},
       primaryClass={cs.LG},
-      url={https://arxiv.org/abs/2503.00031}, 
+      url={https://arxiv.org/abs/2503.00031},
 }
 ```
 
-## Model Card Contact
+**APA:**
 
-[email protected]
+(To be added based on the citation information in the Github README)