janisrebekahv
/

finetuned-colloquial-tamil

@@ -1,205 +1,86 @@
 ---
-library_name: transformers
-datasets:
-- jarvisvasu/english-to-colloquial-tamil
-language:
-- en
-- ta
-base_model:
-- suriya7/English-to-Tamil
 ---
-# 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:
+  - en
+  - ta
+license: cc-by-4.0
+tags:
+  - translation
+  - tamil
+  - colloquial-tamil
+  - fine-tuned
+  - text-to-text
+datasets:
+  - janisrebekahv/colloquial_tamil
+  - jarvisvasu/english-to-colloquial-tamil
+  - chatgpt-generated
+  - youtube-comments
+model-index:
+  - name: janisrebekahv/finetuned-colloquial-tamil
+    results:
+      - task:
+          type: translation
+          name: English to Colloquial Tamil
+        dataset:
+          name: janisrebekahv/colloquial_tamil
+          type: text
+        metrics:
+          - name: BLEU Score
+            type: bleu
+            value: 38.5
+          - name: ROUGE Score
+            type: rouge
+            value: 0.72
 ---
+# janisrebekahv/finetuned-colloquial-tamil
+## 📌 Model Overview
+This is a **fine-tuned version of [suriya7/English-to-Tamil](https://huggingface.co/suriya7/English-to-Tamil)**, trained to produce **colloquial Tamil translations** instead of formal Tamil.
+✅ Translates **English → Colloquial Tamil**
+✅ Incorporates **slang, informal speech, and real-world phrasing**
+✅ Useful for **chatbots, conversational AI, and social media applications**
+---
+## 📜 Dataset
+🔹 **Custom Dataset Used for Fine-Tuning:**
+📂 **[janisrebekahv/colloquial_tamil](https://huggingface.co/datasets/janisrebekahv/colloquial_tamil)**
+This dataset was specifically curated to train this model, improving its ability to translate **English to Colloquial Tamil** accurately.
+This model was fine-tuned on a **custom dataset**, which includes:
+1️⃣ **[jarvisvasu/english-to-colloquial-tamil](https://huggingface.co/datasets/jarvisvasu/english-to-colloquial-tamil)** – A publicly available dataset for informal Tamil translations.
+2️⃣ **YouTube Comments Dataset (Custom-Created)** – Extracted using the **YouTube API** and manually converted to colloquial Tamil for authenticity.
+3️⃣ **ChatGPT-Generated Data** – Additional colloquial Tamil phrases aligned with natural speech patterns.
+📝 **Total dataset size**: **16,269 sentence pairs**
+---
+## 🔥 Example Usage
+Load and test the model using **Hugging Face Transformers**:
+```python
+from transformers import AutoModelForSeq2SeqLM, AutoTokenizer
+# Load model and tokenizer
+model_name = "janisrebekahv/finetuned-colloquial-tamil"
+tokenizer = AutoTokenizer.from_pretrained(model_name)
+model = AutoModelForSeq2SeqLM.from_pretrained(model_name)
+# Function to translate text
+def translate(text):
+    inputs = tokenizer(text, return_tensors="pt")
+    outputs = model.generate(**inputs, max_length=128)
+    return tokenizer.decode(outputs[0], skip_special_tokens=True)
+# Example translations
+test_sentences = [
+    "This is so beautiful",
+    "Bro, are you coming or not?",
+    "My mom is gonna kill me if I don't reach home now!"
+]
+for sentence in test_sentences:
+    print(f"English: {sentence}")
+    print(f"Colloquial Tamil: {translate(sentence)}\n")