HenryHHHH
/

DistilLlama

@@ -1,211 +1,108 @@
 ---
-license: mit
-datasets:
-- Skylion007/openwebtext
-- Salesforce/wikitext
-language:
-- en
-metrics:
-- accuracy
-base_model:
-- meta-llama/Llama-2-7b
-pipeline_tag: text-generation
-tags:
-- Web Text
-- University of Melbourne
-- Knowledge Distillation
----
-# Model Card for Model ID
-<!-- Provide a quick summary of what the model is/does. -->
-This modelcard aims to be a base template for new models. It has been generated using [this raw template](https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/modelcard_template.md?plain=1).
-## Model Details
-### Model Description
-<!-- Provide a longer summary of what this model is. -->
-- **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]

 ---
+### Overview
+This model is a distilled version of LLaMA 2, containing approximately 80 million parameters. It was trained using a mix of OpenWebText and WikiText Raw V1 datasets. Knowledge distillation was employed to transfer knowledge from a larger "teacher" model—Meta’s 7B LLaMA 2—to help this smaller model mimic the behavior of the teacher.
+### Training Process
+During each training step, the input data \( X \) is fed to both the teacher and student models. The student model calculates output logits and loss with the true labels, while the teacher model only generates logits. The total loss combines task-specific loss and distillation loss:
+```python
+def distillation_loss(student_logits, teacher_logits, temperature=2.0):
+    return F.kl_div(
+        F.log_softmax(student_logits / temperature, dim=-1),
+        F.softmax(teacher_logits / temperature, dim=-1),
+        reduction='batchmean'
+    ) * (temperature ** 2)
+# Loss Calculation
+loss = (alpha * distill_loss) + ((1 - alpha) * task_loss)
+```
+### Training Configuration
+- **Batch Size**: 64
+- **Max Sequence Length**: 128
+- **Epochs**: 2
+- **Log Interval**: 3000
+- **Learning Rate**: 3e-4
+- **Warmup Steps**: 4000
+- **Accumulation Steps**: 8
+- **Load Model**: True
+- **Temperature**: 2.0
+- **Alpha**: 0.3
+### Performance Comparison
+The model’s performance is evaluated on 200 queries created in-house. For more details, visit the [GitHub repository](https://github.com/svarnim1805/Knowledge-Distillation/tree/main).
+#### Example Queries
+| **Query**                                    | **Keyword**       |
+|----------------------------------------------|-------------------|
+| The capital of France is                     | Paris             |
+| The author of *To Kill a Mockingbird* is     | Harper Lee        |
+| The planet known as the Red Planet is        | Mars              |
+| The smallest country in the world is         | Vatican City      |
+| The *Mona Lisa* was painted by               | Leonardo da Vinci |
+| The tallest mountain in the world is         | Mount Everest     |
+| The host country of the 2016 Summer Olympics | Brazil            |
+| The currency of Japan is                     | Yen               |
+| The "Father of Computers" is                 | Charles Babbage   |
+| The largest ocean on Earth is                | Pacific Ocean     |
+### Text Generation Examples
+1. **Input**: *The capital of France is*
+   - **Output**: "The capital of France is located in the southern province of Lyon, France. The capital is the main hub of the French capital, La Caillion, and the main hub of the French capital. A major part of the French capital is in the southern city of Paris."
+2. **Input**: *The tallest mountain in the world is*
+   - **Output**: "The tallest mountain in the world is Mount Everest, which is located in the northwest corner of the village of Kahuna. The mountain is about 1,000 feet (3,000 m) above sea level."
+### Evaluation Metrics
+1. **Cosine Similarity using Word Embeddings**
+   - **Description**: Measures semantic similarity by mapping words/phrases to vectors.
+   - **Equation**: Cosine Similarity = \( \frac{\vec{A} \cdot \vec{B}}{||\vec{A}|| \, ||\vec{B}||} \)
+   - **Example**: "The dog chased the cat." vs. "A canine pursued a feline." (High similarity)
+2. **Exact Match (EM)**
+   - **Description**: Checks if critical keywords are present.
+   - **Example**:
+     - Expected: "Paris"
+     - Response: "The capital of France is Paris." (EM = 1)
+3. **ROUGE Score**
+   - **Description**: Measures the overlap of the longest common subsequences between reference and response texts.
+   - **Equation**:
+     - Precision = \( \frac{LCS(R, C)}{\text{Length of } C} \)
+     - Recall = \( \frac{LCS(R, C)}{\text{Length of } R} \)
+### Model Evaluation Summary
+| Model Name      | Duration (s) | Emissions Rate | Avg. EM | Avg. Cosine Similarity | Avg. ROUGE Score |
+|-----------------|--------------|----------------|---------|------------------------|------------------|
+| LLaMA-2-7B-HF   | 18215.61     | 1.01e-05       | 0.715   | 0.7257                 | 0.0821           |
+| baby-llama-58m  | 57.20        | 4.79e-08       | 0.025   | 0.6556                 | 0.0097           |
+| DistilLlama     | 77.12        | 1.01e-05       | 0.02    | 0.6623                 | 0.0115           |
+### Acknowledgments
+- **University of Melbourne**
+- **AGL Energy**
+- **My teammates**: Svarnim and Mohit
+### Reference
+@misc{timiryasov2023babyllamaknowledgedistillation,
+      title={Baby Llama: knowledge distillation from an ensemble of teachers trained on a small dataset with no performance penalty},
+      author={Inar Timiryasov and Jean-Loup Tastet},
+      year={2023},
+      eprint={2308.02019},
+      archivePrefix={arXiv},
+      primaryClass={cs.CL},
+      url={https://arxiv.org/abs/2308.02019},
+}
+*Note: The repository will be updated as training progresses. Last update 2024-10-23*