Update README.md
Browse files
README.md
CHANGED
|
@@ -187,13 +187,75 @@ This repository contains:
|
|
| 187 |
---
|
| 188 |
|
| 189 |
# Usage
|
| 190 |
-
|
| 191 |
Example:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 192 |
|
| 193 |
-
|
| 194 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 195 |
```
|
| 196 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 197 |
Inference modes:
|
| 198 |
|
| 199 |
* OR
|
|
|
|
| 187 |
---
|
| 188 |
|
| 189 |
# Usage
|
|
|
|
| 190 |
Example:
|
| 191 |
+
## Folder Structure
|
| 192 |
+
|
| 193 |
+
```text
|
| 194 |
+
HomayShield/
|
| 195 |
+
β
|
| 196 |
+
βββ datasets/
|
| 197 |
+
β βββ token_level_adversarial_tr_v2.jsonl
|
| 198 |
+
β βββ token_level_adversarial_en_v2.jsonl
|
| 199 |
+
β βββ final_classifier_merged_all.jsonl
|
| 200 |
+
β
|
| 201 |
+
βββ output/
|
| 202 |
+
β βββ Homayv6/
|
| 203 |
+
β βββ homayshield_encoder.pt
|
| 204 |
+
β βββ homayshield_classifier.pt
|
| 205 |
+
β βββ homayshield_attack_bank.npy
|
| 206 |
+
β
|
| 207 |
+
βββ training2.py
|
| 208 |
+
βββ inference.py
|
| 209 |
+
βββ requirements.txt
|
| 210 |
+
```
|
| 211 |
+
|
| 212 |
+
---
|
| 213 |
|
| 214 |
+
## Training Command
|
| 215 |
+
|
| 216 |
+
```bash
|
| 217 |
+
python training2.py \
|
| 218 |
+
--train \
|
| 219 |
+
./datasets/token_level_adversarial_tr_v2.jsonl \
|
| 220 |
+
./datasets/token_level_adversarial_en_v2.jsonl \
|
| 221 |
+
./datasets/final_classifier_merged_all.jsonl \
|
| 222 |
+
--output-dir ./output/Homayv6
|
| 223 |
```
|
| 224 |
|
| 225 |
+
---
|
| 226 |
+
|
| 227 |
+
## Output Files After Training
|
| 228 |
+
|
| 229 |
+
Training generates:
|
| 230 |
+
|
| 231 |
+
```text
|
| 232 |
+
output/Homayv6/
|
| 233 |
+
βββ homayshield_encoder.pt
|
| 234 |
+
βββ homayshield_classifier.pt
|
| 235 |
+
βββ homayshield_attack_bank.npy
|
| 236 |
+
```
|
| 237 |
+
|
| 238 |
+
---
|
| 239 |
+
|
| 240 |
+
## Inference Command
|
| 241 |
+
|
| 242 |
+
```bash
|
| 243 |
+
python inference.py
|
| 244 |
+
```
|
| 245 |
+
|
| 246 |
+
Inference loads:
|
| 247 |
+
|
| 248 |
+
* `homayshield_encoder.pt`
|
| 249 |
+
* `homayshield_classifier.pt`
|
| 250 |
+
* `homayshield_attack_bank.npy`
|
| 251 |
+
|
| 252 |
+
from:
|
| 253 |
+
|
| 254 |
+
```text
|
| 255 |
+
./output/Homayv6/
|
| 256 |
+
```
|
| 257 |
+
|
| 258 |
+
|
| 259 |
Inference modes:
|
| 260 |
|
| 261 |
* OR
|