Jabr7 commited on
Commit
a90d1ee
verified
1 Parent(s): 16e6009

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +43 -168
README.md CHANGED
@@ -2,199 +2,74 @@
2
  library_name: transformers
3
  tags:
4
  - unsloth
 
 
 
 
 
 
 
 
5
  ---
6
 
7
- # Model Card for Model ID
8
-
9
- <!-- Provide a quick summary of what the model is/does. -->
10
-
11
-
12
 
13
  ## Model Details
14
 
15
  ### Model Description
 
 
16
 
17
- <!-- Provide a longer summary of what this model is. -->
18
-
19
- This is the model card of a 馃 transformers model that has been pushed on the Hub. This model card has been automatically generated.
20
-
21
- - **Developed by:** [More Information Needed]
22
- - **Funded by [optional]:** [More Information Needed]
23
- - **Shared by [optional]:** [More Information Needed]
24
- - **Model type:** [More Information Needed]
25
- - **Language(s) (NLP):** [More Information Needed]
26
- - **License:** [More Information Needed]
27
- - **Finetuned from model [optional]:** [More Information Needed]
28
 
29
- ### Model Sources [optional]
 
30
 
31
- <!-- Provide the basic links for the model. -->
32
-
33
- - **Repository:** [More Information Needed]
34
- - **Paper [optional]:** [More Information Needed]
35
- - **Demo [optional]:** [More Information Needed]
36
 
37
  ## Uses
38
 
39
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
40
-
41
  ### Direct Use
 
 
42
 
43
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
44
-
45
- [More Information Needed]
46
-
47
- ### Downstream Use [optional]
48
-
49
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
50
-
51
- [More Information Needed]
52
 
53
  ### Out-of-Scope Use
 
 
54
 
55
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
56
-
57
- [More Information Needed]
58
 
59
  ## Bias, Risks, and Limitations
60
-
61
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
62
-
63
- [More Information Needed]
64
 
65
  ### Recommendations
 
66
 
67
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
68
-
69
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
70
 
71
  ## How to Get Started with the Model
72
 
73
- Use the code below to get started with the model.
74
-
75
- [More Information Needed]
76
-
77
- ## Training Details
78
-
79
- ### Training Data
80
-
81
- <!-- 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. -->
82
-
83
- [More Information Needed]
84
-
85
- ### Training Procedure
86
-
87
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
88
-
89
- #### Preprocessing [optional]
90
-
91
- [More Information Needed]
92
-
93
-
94
- #### Training Hyperparameters
95
-
96
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
97
-
98
- #### Speeds, Sizes, Times [optional]
99
-
100
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
101
-
102
- [More Information Needed]
103
-
104
- ## Evaluation
105
-
106
- <!-- This section describes the evaluation protocols and provides the results. -->
107
-
108
- ### Testing Data, Factors & Metrics
109
-
110
- #### Testing Data
111
-
112
- <!-- This should link to a Dataset Card if possible. -->
113
-
114
- [More Information Needed]
115
-
116
- #### Factors
117
-
118
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
119
-
120
- [More Information Needed]
121
-
122
- #### Metrics
123
-
124
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
125
-
126
- [More Information Needed]
127
-
128
- ### Results
129
-
130
- [More Information Needed]
131
-
132
- #### Summary
133
-
134
-
135
-
136
- ## Model Examination [optional]
137
-
138
- <!-- Relevant interpretability work for the model goes here -->
139
-
140
- [More Information Needed]
141
-
142
- ## Environmental Impact
143
-
144
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
145
-
146
- 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).
147
-
148
- - **Hardware Type:** [More Information Needed]
149
- - **Hours used:** [More Information Needed]
150
- - **Cloud Provider:** [More Information Needed]
151
- - **Compute Region:** [More Information Needed]
152
- - **Carbon Emitted:** [More Information Needed]
153
-
154
- ## Technical Specifications [optional]
155
-
156
- ### Model Architecture and Objective
157
-
158
- [More Information Needed]
159
-
160
- ### Compute Infrastructure
161
-
162
- [More Information Needed]
163
-
164
- #### Hardware
165
-
166
- [More Information Needed]
167
-
168
- #### Software
169
-
170
- [More Information Needed]
171
-
172
- ## Citation [optional]
173
-
174
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
175
-
176
- **BibTeX:**
177
-
178
- [More Information Needed]
179
-
180
- **APA:**
181
-
182
- [More Information Needed]
183
-
184
- ## Glossary [optional]
185
-
186
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
187
-
188
- [More Information Needed]
189
-
190
- ## More Information [optional]
191
-
192
- [More Information Needed]
193
-
194
- ## Model Card Authors [optional]
195
 
196
- [More Information Needed]
 
197
 
198
- ## Model Card Contact
 
 
199
 
200
- [More Information Needed]
 
 
 
 
2
  library_name: transformers
3
  tags:
4
  - unsloth
5
+ - lora
6
+ - gemma
7
+ - whatsapp
8
+ license: apache-2.0
9
+ language:
10
+ - es
11
+ base_model:
12
+ - unsloth/gemma-2-2b-it-bnb-4bit
13
  ---
14
 
15
+ # Model Card for Whatsapp-Finetuned LoRA (Gemma-2-2B-IT-4bit)
 
 
 
 
16
 
17
  ## Model Details
18
 
19
  ### Model Description
20
+ This is a LoRA adapter trained on personal WhatsApp conversations, applied on top of **`unsloth/gemma-2-2b-it-bnb-4bit`**, an instruction-tuned Gemma 2B model in 4-bit quantization.
21
+ The adapter specializes the base model toward informal Spanish conversational style, slang, and context typical of WhatsApp chats.
22
 
23
+ - **Developed by:** Private (Boni)
24
+ - **Model type:** LoRA adapter for causal language modeling
25
+ - **Language(s):** Spanish (es)
26
+ - **Finetuned from model:** `unsloth/gemma-2-2b-it-bnb-4bit`
 
 
 
 
 
 
 
27
 
28
+ ### Model Sources
29
+ - **Base model:** [unsloth/gemma-2-2b-it-bnb-4bit](https://huggingface.co/unsloth/gemma-2-2b-it-bnb-4bit)
30
 
31
+ ---
 
 
 
 
32
 
33
  ## Uses
34
 
 
 
35
  ### Direct Use
36
+ - Chatbots and assistants that mimic WhatsApp-style Spanish conversations.
37
+ - Experimentation with low-rank adapters on personal datasets.
38
 
39
+ ### Downstream Use
40
+ - Can be merged with the base model for full fine-tuned inference.
41
+ - Can be combined with other adapters for multi-domain behavior.
 
 
 
 
 
 
42
 
43
  ### Out-of-Scope Use
44
+ - Production deployment without careful filtering (the dataset is personal, informal, and may not generalize).
45
+ - Sensitive domains like healthcare, law, or safety-critical applications.
46
 
47
+ ---
 
 
48
 
49
  ## Bias, Risks, and Limitations
50
+ - The dataset consists of personal WhatsApp conversations, which may include biases, informal expressions, and idiosyncratic slang.
51
+ - The model may reflect private communication style and does not guarantee factual correctness.
52
+ - Limited training size means performance outside the conversational domain is reduced.
 
53
 
54
  ### Recommendations
55
+ Users should treat outputs as experimental. Avoid relying on this model for factual or professional contexts.
56
 
57
+ ---
 
 
58
 
59
  ## How to Get Started with the Model
60
 
61
+ ```python
62
+ from transformers import AutoModelForCausalLM, AutoTokenizer
63
+ from peft import PeftModel
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
64
 
65
+ base_model = "unsloth/gemma-2-2b-it-bnb-4bit"
66
+ adapter = "YOUR_HF_USERNAME/YOUR_ADAPTER_REPO"
67
 
68
+ tokenizer = AutoTokenizer.from_pretrained(base_model)
69
+ model = AutoModelForCausalLM.from_pretrained(base_model, device_map="auto")
70
+ model = PeftModel.from_pretrained(model, adapter)
71
 
72
+ prompt = "Hola, 驴c贸mo est谩s?"
73
+ inputs = tokenizer(prompt, return_tensors="pt").to("cuda")
74
+ outputs = model.generate(**inputs, max_new_tokens=100)
75
+ print(tokenizer.decode(outputs[0], skip_special_tokens=True))