Upload README.md with huggingface_hub

README.md

@@ -22,49 +22,50 @@ tags:
 
 # 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.
+**TentaGuard** is a lightweight security classifier (guard) — a fine-tune of
+[`Qwen/Qwen3.5-0.8B`](https://huggingface.co/Qwen/Qwen3.5-0.8B). It is used **mainly inside the
+[TentaFlow](https://github.com/Slyb00ts/TentaFlow) application** to scan external content — messages, documents,
+web-search results, etc. — for **hidden attacks** (prompt injection / jailbreak) before it
+reaches the main LLM.
 
-Model NIE generuje odpowiedzi dla uzytkownika — zwraca pojedyncza cyfre:
+The model does NOT generate user-facing replies — it returns a single digit:
 
-| Etykieta | Znaczenie |
-|----------|-----------|
-| `0` | bezpieczne (benign) |
-| `1` | prompt injection / naduzycie narzedzi (atak techniczny) |
-| `2` | jailbreak (manipulacja behawioralna) |
+| Label | Meaning |
+|-------|---------|
+| `0` | benign (safe content) |
+| `1` | prompt injection / tool abuse (technical attack) |
+| `2` | jailbreak (behavioural manipulation) |
 
-Jesli tekst zawiera JEDNOCZESNIE injection i jailbreak → `1`.
+If the text contains BOTH injection and jailbreak → `1`.
 
-## Format wejscia
+## Input format
 
-System prompt (klasyfikator) + wiadomosc uzytkownika `<|guard|>\n{tekst}`. **Buduj prompt
-tokenizerem modelu (`apply_chat_template`)** — nie polegaj na generycznym szablonie czatu.
+A classifier system prompt + a user message `<|guard|>\n{text}`. **Build the prompt with the
+model tokenizer (`apply_chat_template`)** — do not rely on a generic chat template.
 
-## Skutecznosc (zbior testowy guard, 58 przykladow)
+## Accuracy (guard test set, 58 examples)
 
-- Exact (0/1/2): **~96.6%** (pelna precyzja) / **~94.8%** (Q5_K_M)
-- Safe/Unsafe: **~98.3%**
+- Exact (0/1/2): **~96.6%** (full precision) / **~94.8%** (Q5_K_M)
+- Safe / Unsafe: **~98.3%**
 
-## Autorzy
+## Authors
 
-Model wytrenowany przez: **Katarzyna Nowak**, **Piotr Jarocki**, **Damian Pala**, **Jakub Rurański**.
+Trained by: **Katarzyna Nowak**, **Piotr Jarocki**, **Damian Pala**, **Jakub Rurański**.
 
-## Licencja i atrybucja
+## License & attribution
 
-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).
+Apache-2.0, inherited from the base model [`Qwen/Qwen3.5-0.8B`](https://huggingface.co/Qwen/Qwen3.5-0.8B).
+This checkpoint is a fine-tune for attack detection, built for the [TentaFlow](https://github.com/Slyb00ts/TentaFlow) application.
 
-## Uzycie (vLLM)
+## Usage (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.
+`compressed-tensors` format (`nvfp4-pack-quantized`): 4-bit weights (FP4 E2M1, groups of 16,
+FP8 E4M3 block scales + a global FP32 scale), 4-bit activations (W4A4), `lm_head` kept in full
+precision. PTQ calibration via [`llm-compressor`](https://github.com/vllm-project/llm-compressor)
+on real guard prompts.
 
-NVFP4 jest akcelerowany sprzetowo na **Blackwellu (sm_100+)**; na starszych GPU vLLM laduje go
-jako **weight-only** (mniejszy VRAM, bez akceleracji FP4).
+NVFP4 is hardware-accelerated on **Blackwell (sm_100+)**; on older GPUs vLLM loads it as
+**weight-only** (smaller VRAM, no FP4 acceleration).
 
 ```bash
 vllm serve TentaFlow/TentaGuard-NVFP4