thsluck
/

llm-course-hw3-dora

@@ -2,198 +2,134 @@
 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]

 library_name: transformers
 tags: []
 ---
+# DoRA
 <!-- Provide a quick summary of what the model is/does. -->
 ## Model Details
+This repository features a **DoRA** fine-tuned model for tweet sentiment classification trained as part of **VK**'s LLM course.
 ### Model Description
 <!-- Provide a longer summary of what this model is. -->
+**PEFT** (Parameter-Efficient Fine-Tuning) and **DoRA** (Weight-Decomposed Low-Rank Adaptation) are two techniques used in machine learning to efficiently
+adapt large pre-trained neural networks to specific tasks without requiring extensive computational resources.
+**PEFT** (Parameter-Efficient Fine-Tuning): **PEFT** is a technique that focuses on updating only a small subset of the model’s parameters during fine-tuning,
+rather than the entire network. This approach reduces computational costs and memory usage, making it feasible to adapt large models to new tasks on devices
+with limited resources. By targeting specific layers or parameters that are most relevant for the task, **PEFT** achieves significant improvements in efficiency
+while maintaining performance.
+**DoRA** (Weight-Decomposed Low-Rank Adaptation): **DoRA** is a technique for efficiently fine-tuning large pre-trained models by decomposing weight updates into
+low-rank components. This method separates the magnitude and direction of weight updates, allowing for focused and parameter-efficient adaptations.
+By targeting only the most influential components, **DoRA** reduces computational and memory demands while maintaining model performance.
+This approach is particularly useful for adapting models in resource-constrained environments, enabling scalable fine-tuning with minimal resource usage.
+In this case, **OuteAI/Lite-Oute-1-300M-Instruct** is used as the pre-trained model. This model is further fine-tuned using **DoRA** to classify tweet's sentiment.
+## Examples
+### Before fine-tuning
+**Tweet:** QT @user In the original draft of the 7th book, Remus Lupin survived the Battle of Hogwarts. #HappyBirthdayRemusLupin
+**True:** positive
+**Predicted:** The sentiment of the text is negative.
+==================================================================================================================================================
+**Tweet:** "Ben Smith / Smith (concussion) remains out of the lineup Thursday, Curtis #NHL #SJ"
+**True:** neutral
+**Predicted:** The sentiment of the text is negative.
+==================================================================================================================================================
+**Tweet:** Sorry bout the stream last night I crashed out but will be on tonight for sure. Then back to Minecraft in pc tomorrow night.
+**True:** neutral
+**Predicted:** The sentiment of the text is negative.
+==================================================================================================================================================
+**Tweet:** Chase Headley's RBI double in the 8th inning off David Price snapped a Yankees streak of 33 consecutive scoreless innings against Blue Jays
+**True:** neutral
+**Predicted:** The sentiment of the text is negative.
+==================================================================================================================================================
+**Tweet:** @user Alciato: Bee will invest 150 million in January, another 200 in the Summer and plans to bring Messi by 2017"
+**True:** positive
+**Predicted:** The sentiment of the text is negative.
+==================================================================================================================================================
+### After fine-tuning
+**Tweet:** "QT @user In the original draft of the 7th book, Remus Lupin survived the Battle of Hogwarts. #HappyBirthdayRemusLupin"
+**True:** positive
+**Predicted:** positive
+==================================================================================================================================================
+**Tweet:** "Ben Smith / Smith (concussion) remains out of the lineup Thursday, Curtis #NHL #SJ"
+**True:** neutral
+**Predicted:** neutral
+==================================================================================================================================================
+**Tweet:** Sorry bout the stream last night I crashed out but will be on tonight for sure. Then back to Minecraft in pc tomorrow night.
+**True:** neutral
+**Predicted:** neutral
+==================================================================================================================================================
+**Tweet:** Chase Headley's RBI double in the 8th inning off David Price snapped a Yankees streak of 33 consecutive scoreless innings against Blue Jays
+**True:** neutral
+**Predicted:** neutral
+==================================================================================================================================================
+**Tweet:** @user Alciato: Bee will invest 150 million in January, another 200 in the Summer and plans to bring Messi by 2017"
+**True:** positive
+**Predicted:** neutral
+## Analysis
+![image/png](https://cdn-uploads.huggingface.co/production/uploads/67cdb5101908dc5b357809ca/sqdkytzBV4Km_FbYEyPW0.png)
+![image/png](https://cdn-uploads.huggingface.co/production/uploads/67cdb5101908dc5b357809ca/xQ3s6oNU6Gn9g3j_IygNB.png)
+## References
+* Model: OuteAI/Lite-Oute-1-300M-Instruct
+* Dataset: cardiffnlp/tweet_eval
+* Original Article: https://arxiv.org/pdf/2402.09353