Upload README.md with huggingface_hub

README.md

@@ -0,0 +1,71 @@
+---
+license: apache-2.0
+base_model:
+- Qwen/Qwen3.5-0.8B
+pipeline_tag: text-classification
+library_name: transformers
+language:
+- en
+- pl
+tags:
+- nvfp4
+- fp4
+- compressed-tensors
+- vllm
+- quantized
+- tentaguard
+- guard
+- security
+- prompt-injection
+- tentaflow
+---
+
+# TentaGuard — NVFP4 (W4A4, vLLM)
+
+**TentaGuard** to lekki klasyfikator bezpieczenstwa (security guard) — fine-tune
+[`Qwen/Qwen3.5-0.8B`](https://huggingface.co/Qwen/Qwen3.5-0.8B). Wykorzystywany **glownie w aplikacji
+[TentaFlow](https://github.com/Slyb00ts/TentaFlow)** do skanowania tresci z zewnatrz — wiadomosci, dokumentow, wynikow
+wyszukiwan w internecie itp. — pod katem **ukrytych atakow** (prompt injection / jailbreak),
+zanim trafia do glownego LLM.
+
+Model NIE generuje odpowiedzi dla uzytkownika — zwraca pojedyncza cyfre:
+
+| Etykieta | Znaczenie |
+|----------|-----------|
+| `0` | bezpieczne (benign) |
+| `1` | prompt injection / naduzycie narzedzi (atak techniczny) |
+| `2` | jailbreak (manipulacja behawioralna) |
+
+Jesli tekst zawiera JEDNOCZESNIE injection i jailbreak → `1`.
+
+## Format wejscia
+
+System prompt (klasyfikator) + wiadomosc uzytkownika `<|guard|>\n{tekst}`. **Buduj prompt
+tokenizerem modelu (`apply_chat_template`)** — nie polegaj na generycznym szablonie czatu.
+
+## Skutecznosc (zbior testowy guard, 58 przykladow)
+
+- Exact (0/1/2): **~96.6%** (pelna precyzja) / **~94.8%** (Q5_K_M)
+- Safe/Unsafe: **~98.3%**
+
+## Autorzy
+
+Model wytrenowany przez: **Katarzyna Nowak**, **Piotr Jarocki**, **Damian Pala**, **Jakub Rurański**.
+
+## Licencja i atrybucja
+
+Apache-2.0, dziedziczona z modelu bazowego [`Qwen/Qwen3.5-0.8B`](https://huggingface.co/Qwen/Qwen3.5-0.8B).
+Ten checkpoint to fine-tune do detekcji atakow na potrzeby aplikacji [TentaFlow](https://github.com/Slyb00ts/TentaFlow).
+
+## Uzycie (vLLM)
+
+Format `compressed-tensors` (`nvfp4-pack-quantized`): wagi 4-bit (FP4 E2M1, grupy po 16, skale
+FP8 E4M3 + globalna FP32), aktywacje 4-bit (W4A4), `lm_head` w pelnej precyzji. Kalibracja PTQ
+[`llm-compressor`](https://github.com/vllm-project/llm-compressor) na realnych promptach guard.
+
+NVFP4 jest akcelerowany sprzetowo na **Blackwellu (sm_100+)**; na starszych GPU vLLM laduje go
+jako **weight-only** (mniejszy VRAM, bez akceleracji FP4).
+
+```bash
+vllm serve TentaFlow/TentaGuard-NVFP4
+```