Iman-Heshmat commited on
Commit
8221010
1 Parent(s): 60e5f2d

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +60 -179
README.md CHANGED
@@ -1,199 +1,80 @@
1
  ---
2
- library_name: transformers
3
- tags: []
 
 
 
 
 
 
 
 
 
 
4
  ---
5
 
6
- # Model Card for Model ID
7
 
8
- <!-- Provide a quick summary of what the model is/does. -->
9
 
 
 
10
 
 
11
 
12
- ## Model Details
13
 
14
- ### Model Description
15
 
16
- <!-- Provide a longer summary of what this model is. -->
 
 
17
 
18
- This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
 
 
19
 
20
- - **Developed by:** [More Information Needed]
21
- - **Funded by [optional]:** [More Information Needed]
22
- - **Shared by [optional]:** [More Information Needed]
23
- - **Model type:** [More Information Needed]
24
- - **Language(s) (NLP):** [More Information Needed]
25
- - **License:** [More Information Needed]
26
- - **Finetuned from model [optional]:** [More Information Needed]
27
 
28
- ### Model Sources [optional]
29
 
30
- <!-- Provide the basic links for the model. -->
31
 
32
- - **Repository:** [More Information Needed]
33
- - **Paper [optional]:** [More Information Needed]
34
- - **Demo [optional]:** [More Information Needed]
35
 
36
- ## Uses
37
 
38
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
 
 
 
 
 
 
 
 
 
 
39
 
40
- ### Direct Use
41
 
42
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
 
 
 
 
 
 
 
 
 
 
 
43
 
44
- [More Information Needed]
45
 
46
- ### Downstream Use [optional]
47
-
48
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
49
-
50
- [More Information Needed]
51
-
52
- ### Out-of-Scope Use
53
-
54
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
55
-
56
- [More Information Needed]
57
-
58
- ## Bias, Risks, and Limitations
59
-
60
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
61
-
62
- [More Information Needed]
63
-
64
- ### Recommendations
65
-
66
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
67
-
68
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
69
-
70
- ## How to Get Started with the Model
71
-
72
- Use the code below to get started with the model.
73
-
74
- [More Information Needed]
75
-
76
- ## Training Details
77
-
78
- ### Training Data
79
-
80
- <!-- 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. -->
81
-
82
- [More Information Needed]
83
-
84
- ### Training Procedure
85
-
86
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
87
-
88
- #### Preprocessing [optional]
89
-
90
- [More Information Needed]
91
-
92
-
93
- #### Training Hyperparameters
94
-
95
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
96
-
97
- #### Speeds, Sizes, Times [optional]
98
-
99
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
100
-
101
- [More Information Needed]
102
-
103
- ## Evaluation
104
-
105
- <!-- This section describes the evaluation protocols and provides the results. -->
106
-
107
- ### Testing Data, Factors & Metrics
108
-
109
- #### Testing Data
110
-
111
- <!-- This should link to a Dataset Card if possible. -->
112
-
113
- [More Information Needed]
114
-
115
- #### Factors
116
-
117
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
118
-
119
- [More Information Needed]
120
-
121
- #### Metrics
122
-
123
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
124
-
125
- [More Information Needed]
126
-
127
- ### Results
128
-
129
- [More Information Needed]
130
-
131
- #### Summary
132
-
133
-
134
-
135
- ## Model Examination [optional]
136
-
137
- <!-- Relevant interpretability work for the model goes here -->
138
-
139
- [More Information Needed]
140
-
141
- ## Environmental Impact
142
-
143
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
144
-
145
- 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).
146
-
147
- - **Hardware Type:** [More Information Needed]
148
- - **Hours used:** [More Information Needed]
149
- - **Cloud Provider:** [More Information Needed]
150
- - **Compute Region:** [More Information Needed]
151
- - **Carbon Emitted:** [More Information Needed]
152
-
153
- ## Technical Specifications [optional]
154
-
155
- ### Model Architecture and Objective
156
-
157
- [More Information Needed]
158
-
159
- ### Compute Infrastructure
160
-
161
- [More Information Needed]
162
-
163
- #### Hardware
164
-
165
- [More Information Needed]
166
-
167
- #### Software
168
-
169
- [More Information Needed]
170
-
171
- ## Citation [optional]
172
-
173
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
174
-
175
- **BibTeX:**
176
-
177
- [More Information Needed]
178
-
179
- **APA:**
180
-
181
- [More Information Needed]
182
-
183
- ## Glossary [optional]
184
-
185
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
186
-
187
- [More Information Needed]
188
-
189
- ## More Information [optional]
190
-
191
- [More Information Needed]
192
-
193
- ## Model Card Authors [optional]
194
-
195
- [More Information Needed]
196
-
197
- ## Model Card Contact
198
-
199
- [More Information Needed]
 
1
  ---
2
+ base_model: TheBloke/Mistral-7B-Instruct-v0.2-GPTQ
3
+ library_name: peft
4
+ license: apache-2.0
5
+ tags:
6
+ - fine-tuned
7
+ - custom
8
+ - mistral-7b
9
+ - youtube-comments
10
+ - conversational-ai
11
+ model-index:
12
+ - name: imangpt-mistral-7b-youtube-comments-ft
13
+ results: []
14
  ---
15
 
16
+ # imangpt-mistral-7b-youtube-comments-ft
17
 
18
+ This model is a fine-tuned version of [TheBloke/Mistral-7B-Instruct-v0.2-GPTQ](https://huggingface.co/TheBloke/Mistral-7B-Instruct-v0.2-GPTQ), performed by **Iman Heshmat**. The fine-tuning was done using a custom dataset consisting of YouTube audience comments and responses from the respective channel owner. The goal of this fine-tuning process was to enable the model to generate responses that closely mimic the style and tone of the channel owner when replying to audience comments.
19
 
20
+ It achieves the following results on the evaluation set:
21
+ - **Loss:** 1.3211
22
 
23
+ ## Model description
24
 
25
+ This model has been fine-tuned specifically for the task of generating YouTube comment replies in a manner similar to the original channel owner. It has learned to understand the context of comments and respond appropriately, capturing the unique style and tone of the channel owner. This makes the model particularly useful for automating responses to audience interactions on YouTube channels, helping maintain engagement while preserving the channel's voice.
26
 
27
+ ## Intended uses & limitations
28
 
29
+ ### Intended uses:
30
+ - **Automating YouTube comment responses**: The model can be used to automatically generate replies to audience comments on YouTube videos, ensuring consistency in the channel owner's communication style.
31
+ - **Conversational AI applications**: It can also be integrated into other conversational AI systems where maintaining a specific tone and style in responses is crucial.
32
 
33
+ ### Limitations:
34
+ - **Generalization**: The model is specifically fine-tuned on the data of a particular YouTube channel. Its performance may vary when applied to different channels with different communication styles.
35
+ - **Contextual Understanding**: While the model is good at mimicking the style, its understanding of context might be limited to the patterns observed in the training data. It might not perform as well on comments that are vastly different from those in the training set.
36
 
37
+ ## Training and evaluation data
 
 
 
 
 
 
38
 
39
+ The dataset used for fine-tuning consists of YouTube audience comments and the corresponding responses from the channel owner. The data was carefully curated to capture a wide range of interactions, including casual replies, informative responses, and engagement-driven interactions. The dataset reflects real-world usage and aims to enhance the model's ability to generate appropriate and contextually relevant replies.
40
 
41
+ ## Training procedure
42
 
43
+ ### Training hyperparameters
 
 
44
 
45
+ The following hyperparameters were used during training:
46
 
47
+ - **learning_rate:** 0.0002
48
+ - **train_batch_size:** 4
49
+ - **eval_batch_size:** 4
50
+ - **seed:** 42
51
+ - **gradient_accumulation_steps:** 4
52
+ - **total_train_batch_size:** 16
53
+ - **optimizer:** Adam with betas=(0.9,0.999) and epsilon=1e-08
54
+ - **lr_scheduler_type:** linear
55
+ - **lr_scheduler_warmup_steps:** 2
56
+ - **num_epochs:** 10
57
+ - **mixed_precision_training:** Native AMP
58
 
59
+ ### Training results
60
 
61
+ | **Training Loss** | **Epoch** | **Step** | **Validation Loss** |
62
+ |:-----------------:|:---------:|:--------:|:-------------------:|
63
+ | 1.7286 | 0.9231 | 3 | 1.5518 |
64
+ | 1.4587 | 1.8462 | 6 | 1.4154 |
65
+ | 1.3376 | 2.7692 | 9 | 1.3703 |
66
+ | 0.9482 | 4.0 | 13 | 1.3354 |
67
+ | 1.2544 | 4.9231 | 16 | 1.3249 |
68
+ | 1.1956 | 5.8462 | 19 | 1.3228 |
69
+ | 1.1577 | 6.7692 | 22 | 1.3216 |
70
+ | 0.883 | 8.0 | 26 | 1.3217 |
71
+ | 1.1654 | 8.9231 | 29 | 1.3213 |
72
+ | 0.8462 | 9.2308 | 30 | 1.3211 |
73
 
74
+ ### Framework versions
75
 
76
+ - **PEFT:** 0.12.0
77
+ - **Transformers:** 4.42.4
78
+ - **Pytorch:** 2.4.0+cu121
79
+ - **Datasets:** 2.21.0
80
+ - **Tokenizers:** 0.19.1