Update README.md

README.md

@@ -4,6 +4,10 @@ tags:
 - unsloth
 - trl
 - grpo
+license: apache-2.0
+base_model:
+- Qwen/Qwen2.5-3B
+- Qwen/Qwen2.5-VL-3B-Instruct
 ---
 
 # Model Card for Model ID
@@ -18,37 +22,43 @@ tags:
 
 <!-- Provide a longer summary of what this model is. -->
 
-This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
+DeutscheLexAI_BGB is a fine-tuned Qwen2.5-3B model specializing in German legal text processing, trained on the Bürgerliches Gesetzbuch (BGB) dataset. It enhances legal text understanding, summarization, and reasoning for German legal documents.
 
-- **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:** [Ali Asghar (jaffry258@gmail.com)]
+- **Funded by [optional]:** [still under progress ]
+- **Shared by [optional]:** []
+- **Model type:** [Large Language Model (LLM)]
+- **Language(s) (NLP):** [pytorch,transformers,python]
+- **License:** [Appache 2.0]
+- **Finetuned from model [optional]:** [Qwen2.5-3B]
 
 ### Model Sources [optional]
 
 <!-- Provide the basic links for the model. -->
 
-- **Repository:** [More Information Needed]
+- **Repository:** [https://huggingface.co/Alijeff1214/DeutscheLexAI_BGB/tree/main]
 - **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. -->
+DeutscheLexAI_BGB is a fine-tuned Qwen2.5-3B model specializing in German legal text processing, trained on the Bürgerliches Gesetzbuch (BGB) dataset. It enhances legal text understanding, summarization, and reasoning for German legal documents.
 
 ### Direct Use
 
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
+Legal research: Extract, summarize, and analyze BGB texts.
+
+AI-powered legal assistants: Provide insights into German law.
+
+Academic purposes: Assists in legal document structuring.
 
 [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 -->
+Chatbots for legal guidance.
+
+AI-based contract analysis.
 
 [More Information Needed]
 
@@ -60,7 +70,11 @@ This is the model card of a 🤗 transformers model that has been pushed on the
 
 ## Bias, Risks, and Limitations
 
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
+The model may reflect biases in the BGB dataset.
+
+Not suitable for real-time legal decision-making.
+
+Might struggle with non-German legal texts.
 
 [More Information Needed]
 
@@ -95,7 +109,21 @@ Use the code below to get started with the model.
 
 #### 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 -->
+- **Training regime:** [More Information Needed]
+- trainer = GRPOTrainer(
+    model = model,
+    processing_class = tokenizer,
+    reward_funcs = [
+        xmlcount_reward_func,
+        soft_format_reward_func,
+        strict_format_reward_func,
+        int_reward_func,
+        correctness_reward_func,
+    ],
+    args = training_args,
+    train_dataset = dataset,
+)
+trainer.train()
 
 #### Speeds, Sizes, Times [optional]
 
@@ -173,7 +201,14 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
 
 ## Citation [optional]
 
-<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
+@article{DeutscheLexAI_BGB,
+  title={DeutscheLexAI_BGB: A Fine-Tuned Qwen2.5-3B Model for German Legal Texts},
+  author={Your Name or Organization},
+  journal={Hugging Face Model Hub},
+  year={2025},
+  url={https://huggingface.co/Alijeff1214/DeutscheLexAI_BGB}
+}
+
 
 **BibTeX:**