vete-speis commited on
Commit
7609647
·
verified ·
1 Parent(s): f94ec5a

Restore model card

Browse files
Files changed (1) hide show
  1. README.md +58 -180
README.md CHANGED
@@ -1,209 +1,87 @@
1
  ---
 
2
  base_model: google/gemma-4-E2B-it
3
  library_name: peft
4
  pipeline_tag: text-generation
 
 
5
  tags:
6
- - base_model:adapter:google/gemma-4-E2B-it
 
 
7
  - lora
8
- - sft
9
- - transformers
10
- - trl
 
11
  ---
12
 
13
- # Model Card for Model ID
14
 
15
- <!-- Provide a quick summary of what the model is/does. -->
16
 
 
 
 
17
 
 
18
 
19
- ## Model Details
20
 
21
- ### Model Description
 
 
 
22
 
23
- <!-- Provide a longer summary of what this model is. -->
24
 
 
25
 
 
26
 
27
- - **Developed by:** [More Information Needed]
28
- - **Funded by [optional]:** [More Information Needed]
29
- - **Shared by [optional]:** [More Information Needed]
30
- - **Model type:** [More Information Needed]
31
- - **Language(s) (NLP):** [More Information Needed]
32
- - **License:** [More Information Needed]
33
- - **Finetuned from model [optional]:** [More Information Needed]
34
 
35
- ### Model Sources [optional]
36
 
37
- <!-- Provide the basic links for the model. -->
38
 
39
- - **Repository:** [More Information Needed]
40
- - **Paper [optional]:** [More Information Needed]
41
- - **Demo [optional]:** [More Information Needed]
42
 
43
- ## Uses
 
 
 
44
 
45
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
 
 
 
46
 
47
- ### Direct Use
 
 
 
 
 
 
 
48
 
49
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
50
 
51
- [More Information Needed]
 
 
 
52
 
53
- ### Downstream Use [optional]
54
 
55
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
 
 
 
56
 
57
- [More Information Needed]
58
 
59
- ### Out-of-Scope Use
60
-
61
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
62
-
63
- [More Information Needed]
64
-
65
- ## Bias, Risks, and Limitations
66
-
67
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
68
-
69
- [More Information Needed]
70
-
71
- ### Recommendations
72
-
73
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
74
-
75
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
76
-
77
- ## How to Get Started with the Model
78
-
79
- Use the code below to get started with the model.
80
-
81
- [More Information Needed]
82
-
83
- ## Training Details
84
-
85
- ### Training Data
86
-
87
- <!-- 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. -->
88
-
89
- [More Information Needed]
90
-
91
- ### Training Procedure
92
-
93
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
94
-
95
- #### Preprocessing [optional]
96
-
97
- [More Information Needed]
98
-
99
-
100
- #### Training Hyperparameters
101
-
102
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
103
-
104
- #### Speeds, Sizes, Times [optional]
105
-
106
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
107
-
108
- [More Information Needed]
109
-
110
- ## Evaluation
111
-
112
- <!-- This section describes the evaluation protocols and provides the results. -->
113
-
114
- ### Testing Data, Factors & Metrics
115
-
116
- #### Testing Data
117
-
118
- <!-- This should link to a Dataset Card if possible. -->
119
-
120
- [More Information Needed]
121
-
122
- #### Factors
123
-
124
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
125
-
126
- [More Information Needed]
127
-
128
- #### Metrics
129
-
130
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
131
-
132
- [More Information Needed]
133
-
134
- ### Results
135
-
136
- [More Information Needed]
137
-
138
- #### Summary
139
-
140
-
141
-
142
- ## Model Examination [optional]
143
-
144
- <!-- Relevant interpretability work for the model goes here -->
145
-
146
- [More Information Needed]
147
-
148
- ## Environmental Impact
149
-
150
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
151
-
152
- 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).
153
-
154
- - **Hardware Type:** [More Information Needed]
155
- - **Hours used:** [More Information Needed]
156
- - **Cloud Provider:** [More Information Needed]
157
- - **Compute Region:** [More Information Needed]
158
- - **Carbon Emitted:** [More Information Needed]
159
-
160
- ## Technical Specifications [optional]
161
-
162
- ### Model Architecture and Objective
163
-
164
- [More Information Needed]
165
-
166
- ### Compute Infrastructure
167
-
168
- [More Information Needed]
169
-
170
- #### Hardware
171
-
172
- [More Information Needed]
173
-
174
- #### Software
175
-
176
- [More Information Needed]
177
-
178
- ## Citation [optional]
179
-
180
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
181
-
182
- **BibTeX:**
183
-
184
- [More Information Needed]
185
-
186
- **APA:**
187
-
188
- [More Information Needed]
189
-
190
- ## Glossary [optional]
191
-
192
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
193
-
194
- [More Information Needed]
195
-
196
- ## More Information [optional]
197
-
198
- [More Information Needed]
199
-
200
- ## Model Card Authors [optional]
201
-
202
- [More Information Needed]
203
-
204
- ## Model Card Contact
205
-
206
- [More Information Needed]
207
- ### Framework versions
208
-
209
- - PEFT 0.19.1
 
1
  ---
2
+ license: gemma
3
  base_model: google/gemma-4-E2B-it
4
  library_name: peft
5
  pipeline_tag: text-generation
6
+ language:
7
+ - en
8
  tags:
9
+ - phishing
10
+ - email-classification
11
+ - security
12
  - lora
13
+ - gguf
14
+ - gemma4
15
+ datasets:
16
+ - zefang-liu/phishing-email-dataset
17
  ---
18
 
19
+ # Gemma-4-E2B-it Phishing Email Classifier (LoRA)
20
 
21
+ LoRA fine-tune of [google/gemma-4-E2B-it](https://huggingface.co/google/gemma-4-E2B-it) that classifies emails as **`phishing`** or **`legit`** with a single-word answer.
22
 
23
+ This repo contains:
24
+ - the **LoRA adapter** (PEFT, ~50 MB) — reproducible, composable
25
+ - ready-to-run **GGUF** quants (merged model) for llama.cpp / LM Studio: `Q4_K_M` (3.4 GB) and `Q8_0` (5 GB)
26
 
27
+ ## Results
28
 
29
+ Evaluated on 1,000 held-out emails (balanced, English):
30
 
31
+ | Model | Accuracy | Precision | Recall | F1 |
32
+ |---|---|---|---|---|
33
+ | gemma-4-E2B-it zero-shot | 85.7% | 90.3% | 78.9% | 0.842 |
34
+ | **+ this LoRA** | **95.6%** | **98.4%** | **98.0%** | **0.982** |
35
 
36
+ Notes: 26/1000 outputs were off-format and counted as errors (accuracy on parsable outputs: 98.2%). Zero-shot baseline measured on a 300-email subset.
37
 
38
+ ## Usage
39
 
40
+ The model expects this exact system prompt (it was trained with it):
41
 
42
+ ```
43
+ You are an email security classifier. Classify the email as 'phishing' or 'legit'. Respond with one word only.
44
+ ```
 
 
 
 
45
 
46
+ ### LM Studio / llama.cpp (GGUF)
47
 
48
+ Download `phishing-gemma4-e2b-Q4_K_M.gguf`, set the system prompt above, temperature 0, paste an email as the user message. Requires a llama.cpp build recent enough for the `gemma4` architecture.
49
 
50
+ ### Transformers + PEFT (adapter)
 
 
51
 
52
+ ```python
53
+ import torch
54
+ from peft import PeftModel
55
+ from transformers import AutoModelForCausalLM, AutoTokenizer
56
 
57
+ BASE = "google/gemma-4-E2B-it"
58
+ tok = AutoTokenizer.from_pretrained(BASE)
59
+ model = AutoModelForCausalLM.from_pretrained(BASE, dtype=torch.bfloat16, device_map="auto")
60
+ model = PeftModel.from_pretrained(model, "vete-speis/gemma-4-E2B-it-phishing")
61
 
62
+ msgs = [
63
+ {"role": "system", "content": "You are an email security classifier. Classify the email as 'phishing' or 'legit'. Respond with one word only."},
64
+ {"role": "user", "content": "Your account has been suspended. Verify now: http://secure-login.example.xyz"},
65
+ ]
66
+ ids = tok.apply_chat_template(msgs, add_generation_prompt=True, return_tensors="pt").to(model.device)
67
+ out = model.generate(ids, max_new_tokens=5, do_sample=False)
68
+ print(tok.decode(out[0, ids.shape[1]:], skip_special_tokens=True)) # -> phishing
69
+ ```
70
 
71
+ ## Training
72
 
73
+ - **Base:** google/gemma-4-E2B-it (2.3B effective params)
74
+ - **Data:** [zefang-liu/phishing-email-dataset](https://huggingface.co/datasets/zefang-liu/phishing-email-dataset), cleaned, class-balanced 50/50, 10.5k train / 500 val / 1,000 test, emails truncated to 1,500 chars
75
+ - **Method:** SFT with TRL `SFTTrainer` + PEFT LoRA — r=16, alpha=32, dropout 0.05, targets: the inner `nn.Linear` of q/k/v/o projections (Gemma 4 wraps them in `Gemma4ClippableLinear`, which PEFT cannot wrap directly)
76
+ - **Run:** 1 epoch, effective batch 16 (4×4), seq len 512, lr 2e-4 cosine, bf16, gradient checkpointing — ~15 min on a single H100 (Modal)
77
 
78
+ ## Limitations
79
 
80
+ - Trained on **English** emails. It generalizes surprisingly well to other languages (the base is multilingual), but no formal eval outside English.
81
+ - The dataset's "phishing" class includes generic spam, so the model leans toward flagging unsolicited marketing/cold-outreach emails as `phishing`. If you need a strict spam ≠ phishing distinction, you need 3-class data.
82
+ - ~2.6% of outputs may be off-format; parse with a contains-check on `phishing`/`legit` and treat anything else as abstention.
83
+ - Not a substitute for a mail security gateway. Use as a triage aid.
84
 
85
+ ## License
86
 
87
+ Gemma derivatives are governed by the [Gemma Terms of Use](https://ai.google.dev/gemma/terms). The adapter and GGUF files here are derivatives of google/gemma-4-E2B-it.