Update README.md

README.md

@@ -1,199 +1,200 @@
 ---
 library_name: transformers
-tags: []
+tags:
+  - code
+  - coding-assistant
+  - indian-languages
+  - hindi
+  - multilingual
+  - qwen2
+  - lora
+  - fine-tuned
+  - indian-history
+  - indic-nlp
+license: apache-2.0
+language:
+  - en
+  - hi
+  - bn
+  - ta
+  - te
+  - mr
+  - gu
+  - kn
+  - ml
+  - pa
+  - or
+base_model: Qwen/Qwen2.5-Coder-1.5B-Instruct
+pipeline_tag: text-generation
 ---
 
-# Model Card for Model ID
+# 🇮🇳 Indra — Indian Language AI Assistant
 
-<!-- Provide a quick summary of what the model is/does. -->
+**Indra** is a fine-tuned LLM built on **Qwen2.5-Coder-1.5B-Instruct**, trained on Indian language and history datasets. It can converse in **10 Indian languages**, answer questions about **Indian history & culture**, and still write code.
 
+## ✨ Highlights
 
+- 🗣️ **10 Indian languages** — Hindi, Bengali, Tamil, Telugu, Marathi, Gujarati, Kannada, Malayalam, Punjabi, Odia
+- 📜 **Indian history & culture** — From Indus Valley to modern India
+- 🔄 **Bilingual conversations** — Hinglish, code-switching, vernacular queries
+- 💻 **Coding preserved** — Still writes Python, JavaScript, and full-stack code
+- 📦 **Lightweight** — 1.5B parameters, runs on consumer GPUs
 
-## 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
+## Quick Start
 
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
+```python
+from transformers import AutoModelForCausalLM, AutoTokenizer
 
-[More Information Needed]
+model = AutoModelForCausalLM.from_pretrained("RockySinghRajput/Indra", torch_dtype="auto", device_map="auto")
+tokenizer = AutoTokenizer.from_pretrained("RockySinghRajput/Indra")
 
-## Bias, Risks, and Limitations
+messages = [
+    {"role": "system", "content": "आप Indra हैं, एक बुद्धिमान AI सहायक।"},
+    {"role": "user", "content": "भारत के स्वतंत्रता संग्राम के बारे में बताइए।"}
+]
 
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
+text = tokenizer.apply_chat_template(messages, tokenize=False, add_generation_prompt=True)
+inputs = tokenizer([text], return_tensors="pt").to(model.device)
 
-[More Information Needed]
+output = model.generate(inputs.input_ids, max_new_tokens=512, temperature=0.7, top_p=0.9)
+print(tokenizer.decode(output[0][len(inputs.input_ids[0]):], skip_special_tokens=True))
+```
 
-### Recommendations
+### Hinglish Example
 
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
+```python
+messages = [
+    {"role": "system", "content": "You are Indra, a helpful AI that understands Hindi and English."},
+    {"role": "user", "content": "Mujhe Python mein ek calculator banana hai, kaise karoon?"}
+]
+```
 
-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.
+## Model Details
 
-[More Information Needed]
+| Property | Value |
+|----------|-------|
+| **Base Model** | [Qwen/Qwen2.5-Coder-1.5B-Instruct](https://huggingface.co/Qwen/Qwen2.5-Coder-1.5B-Instruct) |
+| **Parameters** | 1.5B |
+| **Type** | Causal Language Model (merged LoRA fine-tune) |
+| **Languages** | English, Hindi, Bengali, Tamil, Telugu, Marathi, Gujarati, Kannada, Malayalam, Punjabi, Odia |
+| **License** | Apache 2.0 |
+| **Developed by** | [RockySinghRajput](https://huggingface.co/RockySinghRajput) |
+| **Related Model** | [IndraCoder](https://huggingface.co/RockySinghRajput/Indracoder) (coding-focused version) |
+
+## Supported Languages
+
+| Language | Script | Code |
+|----------|--------|------|
+| Hindi | देवनागरी | hi |
+| Bengali | বাংলা | bn |
+| Tamil | தமிழ் | ta |
+| Telugu | తెలుగు | te |
+| Marathi | मराठी | mr |
+| Gujarati | ગુજરાતી | gu |
+| Kannada | ಕನ್ನಡ | kn |
+| Malayalam | മലയാളം | ml |
+| Punjabi | ਪੰਜਾਬੀ | pa |
+| Odia | ଓଡ଼ିଆ | or |
+| English | Latin | en |
 
 ## 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
-
-
+Fine-tuned on **6 Indian language & culture datasets**:
 
-## Model Examination [optional]
+| Dataset | Purpose | Content |
+|---------|---------|---------|
+| [CohereForAI/aya_dataset](https://huggingface.co/datasets/CohereForAI/aya_dataset) | Multilingual Indian conversations | 10 Indian languages |
+| [Cognitive-Lab/Hindi-Instruct](https://huggingface.co/datasets/Cognitive-Lab/Hindi-Instruct) | Hindi instruction following | Hindi Q&A |
+| [sarvamai/samvaad-hi-en-instruct-v2](https://huggingface.co/datasets/sarvamai/samvaad-hi-en-instruct-v2) | Bilingual conversations | Hindi-English |
+| CohereForAI/aya_collection (India-filtered) | Indian history & culture | History, heritage, knowledge |
+| CohereForAI/aya_collection (Hindi WikiQA) | Hindi knowledge base | Wikipedia-sourced Hindi QA |
+| ai4bharat/IndicSentiment | Hindi language understanding | Sentiment analysis |
 
-<!-- Relevant interpretability work for the model goes here -->
+### Indian History Coverage
 
-[More Information Needed]
+The model has been trained on Indian history spanning:
 
-## Environmental Impact
+- **Ancient India** — Indus Valley Civilization, Vedic period, Maurya & Gupta Empires
+- **Medieval India** — Delhi Sultanate, Mughal Empire, Vijayanagara, Maratha Empire, Bhakti & Sufi movements
+- **Modern India** — British Raj, Freedom struggle, Independence, Republic
+- **Indian Constitution** — Fundamental rights, governance, democracy
+- **Culture & Heritage** — Art, architecture, literature, philosophy, classical music, Ayurveda, Yoga
 
-<!-- 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
+### Training Procedure
 
-[More Information Needed]
+- **Method**: LoRA (Low-Rank Adaptation) → merged into base model
+- **LoRA Config**: r=16, alpha=16, dropout=0.05
+- **Target Modules**: q_proj, k_proj, v_proj, o_proj
+- **Epochs**: 2
+- **Learning Rate**: 2e-5 (lower to preserve base capabilities)
+- **Optimizer**: paged_adamw_8bit
+- **Sequence Length**: 512 tokens
+- **Precision**: FP16 mixed precision
+- **Quantization**: 4-bit NF4 (QLoRA) during training
 
 ### Compute Infrastructure
 
-[More Information Needed]
-
-#### Hardware
-
-[More Information Needed]
-
-#### Software
+- **Hardware**: NVIDIA T4 GPU
+- **Training Time**: ~2 hours
 
-[More Information Needed]
+## Capabilities
 
-## Citation [optional]
+### ✅ What Indra Can Do
 
-<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
+- **Converse in Indian languages** — Answer questions in Hindi, Bengali, Tamil, Telugu, and more
+- **Indian history & culture** — Detailed knowledge of Indian civilization
+- **Hinglish/bilingual** — Handle mixed Hindi-English naturally
+- **General knowledge** — Science, geography, current affairs with Indian context
+- **Coding** — Write code in Python, JavaScript, and other languages
+- **Sentiment analysis** — Understand sentiment in Hindi text
 
-**BibTeX:**
+### ⚠️ Limitations
 
-[More Information Needed]
+- **1.5B model** — Smaller than commercial LLMs; may produce shorter or less nuanced responses
+- **Script limitations** — Stronger in Hindi/Devanagari; other Indian scripts may have lower quality
+- **Not a translator** — Optimized for conversation, not professional translation
+- **May hallucinate** — Always verify historical facts and generated content
+- **English-centric base** — Indian language abilities are fine-tuned on top of an English-dominant base
 
-**APA:**
+### ❌ Out-of-Scope Use
 
-[More Information Needed]
+- Professional translation services
+- Legal or medical advice
+- Factual source of record for academic research
+- Generating harmful or culturally insensitive content
 
-## 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
+## Evaluation
 
-[More Information Needed]
+| Test | Language | Task | Result |
+|------|----------|------|--------|
+| Hindi Chat | Hindi | Gandhi's role in freedom struggle | ✅ Detailed response |
+| Indian History | English | Gupta Empire Golden Age | ✅ Accurate overview |
+| Hinglish | Mixed | "Python mein calculator banana hai" | ✅ Code + Hindi explanation |
+| Coding | English | Binary search implementation | ✅ Working code |
+| Indian Culture | Hindi | Classical music ragas | ✅ Cultural knowledge |
+
+## Model Family
+
+| Model | Focus | Repo |
+|-------|-------|------|
+| **Indra** (this model) | Indian languages + history | [RockySinghRajput/Indra](https://huggingface.co/RockySinghRajput/Indra) |
+| **IndraCoder** | Coding + debugging | [RockySinghRajput/Indracoder](https://huggingface.co/RockySinghRajput/Indracoder) |
+| **IndraCoder-7B** | Advanced coding + chat (coming soon) | [RockySinghRajput/IndraCoder-7B](https://huggingface.co/RockySinghRajput/IndraCoder-7B) |
+
+## Citation
+
+```bibtex
+@misc{indra2025,
+  title={Indra: An Indian Language AI Assistant},
+  author={RockySinghRajput},
+  year={2025},
+  publisher={HuggingFace},
+  url={https://huggingface.co/RockySinghRajput/Indra}
+}
+```
+
+## Contact
+
+- **HuggingFace**: [RockySinghRajput](https://huggingface.co/RockySinghRajput)