ninadp
/

marathi-mitra-phi3

@@ -1,199 +1,100 @@
 ---
-library_name: transformers
-tags: []
 ---
-# Model Card for Model ID
-<!-- Provide a quick summary of what the model is/does. -->
 ## Model Details
-### Model Description
-<!-- 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.
-- **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]
-### Model Sources [optional]
-<!-- 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]
-### 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.
-[More Information Needed]
 ## 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. -->
-[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]
-## 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. -->
-**BibTeX:**
-[More Information Needed]
-**APA:**
-[More Information Needed]
-## Glossary [optional]
-<!-- 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 Authors [optional]
-[More Information Needed]
-## Model Card Contact
-[More Information Needed]

 ---
+language:
+- mr
+- en
+base_model: microsoft/Phi-3-mini-4k-instruct
+tags:
+- marathi
+- indian-language
+- lora
+- peft
+- fine-tuned
+- education
+- kids
+license: mit
 ---
+# 🌸 Marathi Mitra — माझा मराठी मित्र
+Fine-tuned Phi-3 Mini for Marathi vocabulary learning,
+built as a personalized tool to help my daughter learn Marathi.
 ## Model Details
+| Property | Value |
+|----------|-------|
+| Base Model | microsoft/Phi-3-mini-4k-instruct |
+| Fine-tuning Method | QLoRA (SFT) |
+| LoRA Rank | r=32, alpha=64 |
+| Training Examples | 30 Marathi vocabulary items |
+| Best Experiment | exp4_lr2e4_epochs25_r32 |
+| Format Score | 36.4% |
+| Training Hardware | Google Colab T4 GPU |
+## What It Does
+Given an English word, generates a Marathi lesson with:
+- Marathi word in Devanagari script
+- Pronunciation guide
+- Example sentence
+- Fun fact for kids
+## How to Use
+```python
+from transformers import AutoModelForCausalLM, AutoTokenizer
+from peft import PeftModel
+import torch
+base = AutoModelForCausalLM.from_pretrained(
+    "microsoft/Phi-3-mini-4k-instruct",
+    torch_dtype=torch.float16,
+    trust_remote_code=True,
+)
+model = PeftModel.from_pretrained(base, "ninadp/marathi-mitra-phi3")
+tokenizer = AutoTokenizer.from_pretrained(
+    "microsoft/Phi-3-mini-4k-instruct",
+    trust_remote_code=True,
+)
+prompt = """### Instruction:
+You are Marathi Mitra, a friendly Marathi teacher for kids.
+### Input:
+Teach me the Marathi word for: butterfly
+### Response:
+"""
+inputs = tokenizer(prompt, return_tensors="pt")
+output = model.generate(**inputs, max_new_tokens=150)
+print(tokenizer.decode(output[0], skip_special_tokens=True))
+```
 ## Training Details
+Fine-tuned using Supervised Fine-Tuning (SFT) with QLoRA
+on 30 Marathi vocabulary examples across 4 hyperparameter
+experiments.
+| Experiment | LR | Epochs | Loss | Score |
+|------------|-----|--------|------|-------|
+| Baseline | N/A | N/A | N/A | 11.2% |
+| Exp1 | 2e-4 | 5 | 1.29 | 12.8% |
+| Exp2 | 2e-4 | 25 | 0.20 | 28.8% |
+| Exp3 | 1e-4 | 25 | 0.37 | 16.0% |
+| Exp4 | 2e-4 | 25 | 0.22 | 36.4% ✅ |
+## Limitations
+- Trained on only 30 examples — vocabulary coverage is limited
+- May generate incorrect Marathi words for unseen vocabulary
+- Format learned well; accuracy improves with more data
+- Retraining with 200+ examples planned
+## Live Demo
+[🚀 Try it on HF Spaces](https://huggingface.co/spaces/ninadp/marathi-mitra)
+## GitHub
+[📦 Full project code](https://github.com/ninadparab/marathi-mitra)