Update README.md

README.md

@@ -45,19 +45,23 @@ should probably proofread and complete it, then remove this comment. -->
 
 # modernbert-setfit-nli
 
-This model was trained from scratch on an unknown dataset.
+## Model Description
 
-## Model description
+This model is a fine-tuned version of `answerdotai/ModernBERT-base` trained on a subset of the SetFit/mnli dataset. It is designed for natural language inference (NLI) tasks, where the goal is to determine the relationship between two text inputs (e.g., entailment, contradiction, or neutrality).
 
-More information needed
+## Intended Uses & Limitations
 
-## Intended uses & limitations
+### Intended Uses
+- **Natural Language Inference (NLI):** Suitable for classifying relationships between pairs of sentences.
+- **Text Understanding Tasks:** Can be applied to other similar tasks requiring sentence pair classification.
 
-More information needed
+### Limitations
+- **Dataset-Specific Biases:** The model was fine-tuned on 30,000 samples from the SetFit/mnli dataset and may not generalize well to domains significantly different from the training data.
+- **Context Length:** The tokenizer’s maximum sequence length is 512 tokens. Inputs longer than this will be truncated.
+- **Resource Intensive:** May require a modern GPU for efficient inference on large datasets.
 
-## Training and evaluation data
+This model is a starting point for NLI tasks and may need further fine-tuning for domain-specific applications.
 
-More information needed
 
 ## Training procedure
 
@@ -77,4 +81,7 @@ The following hyperparameters were used during training:
 - Transformers 4.48.0
 - Pytorch 2.5.1+cu121
 - Datasets 3.2.0
-- Tokenizers 0.21.0
+- Tokenizers 0.21.0
+## References
+
+- **GitHub Repository:** The training code is available at [GitHub Repository Link](https://github.com/sfarrukhm/model_finetune.git).