Akash-Sakala commited on
Commit
a7ef4a8
·
verified ·
1 Parent(s): 36b18c2

Add model card with metrics and dataset info

Browse files
Files changed (1) hide show
  1. README.md +93 -174
README.md CHANGED
@@ -1,199 +1,118 @@
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
+ language:
3
+ - en
4
+ license: apache-2.0
5
+ base_model: distilbert/distilbert-base-uncased
6
+ tags:
7
+ - text-classification
8
+ - phishing-detection
9
+ - knowledge-distillation
10
+ - distilbert
11
+ datasets:
12
+ - Akash-Sakala/phishing-site-classification
13
+ metrics:
14
+ - accuracy
15
+ - f1
16
+ - precision
17
+ - recall
18
+ model-index:
19
+ - name: bert-phishing-classifier_student
20
+ results:
21
+ - task:
22
+ type: text-classification
23
+ name: Text Classification
24
+ dataset:
25
+ name: Akash-Sakala/phishing-site-classification
26
+ type: Akash-Sakala/phishing-site-classification
27
+ split: test
28
+ metrics:
29
+ - type: accuracy
30
+ value: 0.9601
31
+ name: Accuracy
32
+ - type: f1
33
+ value: 0.9595
34
+ name: F1
35
+ - type: precision
36
+ value: 0.9710
37
+ name: Precision
38
+ - type: recall
39
+ value: 0.9483
40
+ name: Recall
41
  ---
42
 
43
+ # DistilBERT Phishing Site Classifier (Student)
 
 
 
44
 
45
+ A 4-layer DistilBERT trained via **knowledge distillation** from a fine-tuned BERT teacher
46
+ ([Akash-Sakala/bert-phishing-classifier_teacher](https://huggingface.co/Akash-Sakala/bert-phishing-classifier_teacher))
47
+ for binary phishing site URL classification.
48
 
49
  ## Model Details
50
 
51
+ | Property | Value |
52
+ |-----------------|-------------------------------------------|
53
+ | Base model | distilbert/distilbert-base-uncased |
54
+ | Architecture | DistilBertForSequenceClassification |
55
+ | Layers | 4 (distilled from 12-layer BERT teacher) |
56
+ | Attention heads | 8 |
57
+ | Task | Binary classification (phishing / benign) |
58
+ | Parameters | ~52M |
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
59
 
60
+ ## Training — Distillation Setup
61
 
62
+ | Hyperparameter | Value |
63
+ |-------------------|--------------------|
64
+ | Temperature | 3.0 |
65
+ | Alpha (KL weight) | 0.6 |
66
+ | Hard label weight | 0.4 |
67
+ | Learning rate | 2e-5 |
68
+ | Batch size | 64 |
69
+ | Epochs | 4 |
70
+ | Warmup steps | 10% of total steps |
71
+ | Weight decay | 0.01 |
72
+ | Optimizer | AdamW |
73
+ | Scheduler | Linear with warmup |
74
+ | Mixed precision | fp16 (torch.amp) |
75
 
76
+ ## Loss Function
77
 
78
+ Combined KL divergence (soft targets) + Cross-Entropy (hard labels):
79
 
80
+ loss = alpha * KL(student_soft || teacher_soft) * T^2 + (1 - alpha) * CrossEntropy(student, labels)
81
 
82
+ ## Test Set Results
83
 
84
+ | Model | Accuracy | Precision | Recall | F1 |
85
+ |------------------------|------------|------------|------------|------------|
86
+ | BERT Teacher | 0.8971 | 0.9136 | 0.8763 | 0.8945 |
87
+ | **DistilBERT Student** | **0.9601** | **0.9710** | **0.9483** | **0.9595** |
88
 
89
+ The student **outperforms the teacher** across all metrics while being smaller and faster.
90
 
91
+ ## Dataset
92
 
93
+ - **Dataset:** [Akash-Sakala/phishing-site-classification](https://huggingface.co/datasets/Akash-Sakala/phishing-site-classification)
94
+ - Train: 154,000 | Validation: 33,000 | Test: 33,000
95
+ - Labels: `0` = benign, `1` = phishing
96
 
97
+ ## Usage
98
 
99
+ ```python
100
+ from transformers import AutoTokenizer, AutoModelForSequenceClassification
101
+ import torch
102
 
103
+ tokenizer = AutoTokenizer.from_pretrained('Akash-Sakala/bert-phishing-classifier_student')
104
+ model = AutoModelForSequenceClassification.from_pretrained('Akash-Sakala/bert-phishing-classifier_student')
105
 
106
+ url = 'http://suspicious-login.verify-account.com/secure'
107
+ inputs = tokenizer(url, return_tensors='pt', truncation=True, padding='max_length')
108
 
109
+ with torch.no_grad():
110
+ logits = model(**inputs).logits
111
 
112
+ pred = torch.argmax(logits, dim=1).item()
113
+ print('Phishing' if pred == 1 else 'Benign')
114
+ ```
115
 
116
+ ## Teacher Model
117
 
118
+ [Akash-Sakala/bert-phishing-classifier_teacher](https://huggingface.co/Akash-Sakala/bert-phishing-classifier_teacher)