MonicaDasari
/

FinalProject

Safetensors

Model card Files Files and versions

xet

Community

MonicaDasari commited on Dec 10, 2024

Commit

4d1785d

verified ·

1 Parent(s): 231e21f

Update README.md

Browse files

Files changed (1) hide show

README.md +67 -167

README.md CHANGED Viewed

@@ -1,199 +1,99 @@
----
-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]

+Here’s a **README** template for your project, designed to highlight the models used, evaluation methodology, and key results. You can adapt this for Hugging Face or any similar platform.
+---
+# **English-to-Japanese Translation Project**
+## **Overview**
+This project focuses on building a robust system for English-to-Japanese translation using state-of-the-art multilingual models. Two models were used: **mT5** as the primary model and **mBART** as the secondary model. Together, they ensure high-quality translations and versatility in multilingual tasks.
+---
+## **Models Used**
+### **1. mT5 (Primary Model)**
+- **Reason for Selection**:
+  - mT5 is highly versatile and trained on a broad multilingual dataset, making it suitable for translation and other tasks like summarization or answering questions.
+  - It performs well without extensive fine-tuning, saving computational resources.
+- **Strengths**:
+  - Handles translation naturally with minimal training.
+  - Can perform additional tasks beyond translation.
+- **Limitations**:
+  - Sometimes lacks precision in detailed translations.
+---
+### **2. mBART (Secondary Model)**
+- **Reason for Selection**:
+  - mBART specializes in multilingual translation tasks and provides highly accurate translations when fine-tuned.
+- **Strengths**:
+  - Optimized for translation accuracy, especially for long sentences and contextual consistency.
+  - Handles grammatical and contextual errors well.
+- **Limitations**:
+  - Less flexible for tasks like summarization or question answering compared to mT5.
+---
+## **Evaluation Strategy**
+To evaluate model performance, the following metrics were used:
+1. **BLEU Score**:
+   - Measures how close the model's output is to the correct translation.
+   - Chosen because it is a standard for evaluating translation accuracy.
+2. **Training Loss**:
+   - Tracks how well the model is learning during training.
+   - A lower loss shows better learning and fewer errors.
+3. **Perplexity**:
+   - Checks the confidence of the model’s predictions.
+   - Lower perplexity means fewer mistakes and more fluent translations.
+---
+## **Steps Taken**
+1. Fine-tuned both models using a dataset of English-Japanese text pairs to improve translation accuracy.
+2. Tested the models on unseen data to measure their real-world performance.
+3. Applied optimizations like **4-bit quantization** to reduce memory usage and make the models faster during evaluation.
+---
+## **Results**
+- **mT5**:
+  - Performed well in handling translations and additional tasks like summarization and answering questions.
+  - Showed versatility but sometimes lacked detailed accuracy for translations.
+- **mBART**:
+  - Delivered precise and contextually accurate translations, especially for longer sentences.
+  - Required fine-tuning but outperformed mT5 in translation-focused tasks.
+- **Overall Conclusion**:
+  mT5 is a flexible model for multilingual tasks, while mBART ensures high-quality translations. Together, they balance versatility and accuracy, making them ideal for English-to-Japanese translations.
+---
+## **How to Use**
+1. Load the models from Hugging Face
+2. Fine-tune the models for your dataset using English-Japanese text pairs.
+3. Evaluate performance using BLEU Score, training loss, and perplexity.
+---
+## **Future Work**
+- Expand the dataset for better fine-tuning.
+- Explore task-specific fine-tuning for mT5 to improve its translation accuracy.
+- Optimize the models further for deployment in resource-constrained environments.
+---
+## **References**
+- [mT5: Exploring the Limits of Transfer Learning with a Unified Text-to-Text Transformer](https://arxiv.org/abs/2010.11934)
+- [mBART: Multilingual Denoising Pretraining for Neural Machine Translation](https://arxiv.org/abs/2001.08210)
+---