cybersectony
commited on
Commit
•
5cdd99f
1
Parent(s):
d641088
Update README.md
Browse files
README.md
CHANGED
@@ -14,38 +14,38 @@ tags:
|
|
14 |
- Detection
|
15 |
---
|
16 |
|
17 |
-
|
18 |
|
19 |
-
|
20 |
|
21 |
This model is specifically fine-tuned for detecting phishing emails using the Hugging Face Trainer API.
|
22 |
|
23 |
-
|
24 |
- __Base Architecture:__ DistilBERT
|
25 |
- __Task:__ Multilabel Classification
|
26 |
- __Fine-tuning Framework:__ Hugging Face Trainer API
|
27 |
- __Training Duration:__ 3 epochs
|
28 |
|
29 |
-
|
30 |
- __F1-score:__ 97.717
|
31 |
- __Accuracy:__ 97.716
|
32 |
- __Precision:__ 97.736
|
33 |
- __Recall:__ 97.717
|
34 |
|
35 |
-
|
36 |
|
37 |
This model was trained using a [Phishing Email Detection Dataset](https://huggingface.co/datasets/cybersectony/PhishingEmailDetection).
|
38 |
|
39 |
-
|
40 |
|
41 |
-
|
42 |
|
43 |
```bash
|
44 |
pip install transformers
|
45 |
pip install torch
|
46 |
```
|
47 |
|
48 |
-
|
49 |
|
50 |
```python
|
51 |
from transformers import AutoTokenizer, AutoModelForSequenceClassification
|
@@ -90,7 +90,7 @@ def predict_email(email_text):
|
|
90 |
}
|
91 |
```
|
92 |
|
93 |
-
|
94 |
|
95 |
```python
|
96 |
# Example usage
|
|
|
14 |
- Detection
|
15 |
---
|
16 |
|
17 |
+
# A distilBERT based Phishing Email Detection Model
|
18 |
|
19 |
+
## Model Overview
|
20 |
|
21 |
This model is specifically fine-tuned for detecting phishing emails using the Hugging Face Trainer API.
|
22 |
|
23 |
+
## Key Specifications
|
24 |
- __Base Architecture:__ DistilBERT
|
25 |
- __Task:__ Multilabel Classification
|
26 |
- __Fine-tuning Framework:__ Hugging Face Trainer API
|
27 |
- __Training Duration:__ 3 epochs
|
28 |
|
29 |
+
## Performance Metrics
|
30 |
- __F1-score:__ 97.717
|
31 |
- __Accuracy:__ 97.716
|
32 |
- __Precision:__ 97.736
|
33 |
- __Recall:__ 97.717
|
34 |
|
35 |
+
## Dataset Details
|
36 |
|
37 |
This model was trained using a [Phishing Email Detection Dataset](https://huggingface.co/datasets/cybersectony/PhishingEmailDetection).
|
38 |
|
39 |
+
## Usage Guide
|
40 |
|
41 |
+
## Installation
|
42 |
|
43 |
```bash
|
44 |
pip install transformers
|
45 |
pip install torch
|
46 |
```
|
47 |
|
48 |
+
## Quick Start
|
49 |
|
50 |
```python
|
51 |
from transformers import AutoTokenizer, AutoModelForSequenceClassification
|
|
|
90 |
}
|
91 |
```
|
92 |
|
93 |
+
## Example Usage
|
94 |
|
95 |
```python
|
96 |
# Example usage
|