Aktualizovat sk1/README.md

sk1/README.md

@@ -48,3 +48,74 @@ Webová aplikácia na klasifikáciu textov a detekciu nenávistnej alebo toxicke
 └── README.md               # Dokumentácia projektu
 ```
 
+## Ako aplikáciu použiť
+
+1. Otvor frontend:  
+   [https://hate-frontend-production.up.railway.app](https://hate-frontend-production.up.railway.app)
+
+2. Zadaj text do vstupného poľa
+
+3. Klikni na tlačidlo **„Analyzovať“**
+
+4. Výsledok sa zobrazí a zároveň uloží do histórie
+
+5. Históriu si môžeš pozrieť cez:  
+   [https://hate-backend-production.up.railway.app/api/history](https://hate-backend-production.up.railway.app/api/history)
+
+### Lokálne spustenie
+
+**Požiadavky:**  
+- OS: Linux/macOS alebo WSL  
+- Docker + Docker Compose
+
+```bash
+chmod +x prepare-app.sh remove-app.sh
+./prepare-app.sh     # Build a spustenie
+./remove-app.sh      # Zastavenie a vyčistenie
+```
+
+## API Endpointy
+
+- `POST /api/predict` – predikcia toxickosti zadaného textu
+- `GET /api/history` – výpis histórie všetkých analyzovaných textov
+
+## Model strojového učenia
+
+- **Názov:** [`tetianamohorian/hate_speech_model`](https://huggingface.co/tetianamohorian/hate_speech_model)
+- **Architektúra:** vlastný klasifikačný model trénovaný na báze Slovak-T5-base-small.
+Model bol vlastnoručne fine-tunovaný na binárnu klasifikáciu textov (toxický vs. neutrálny) s použitím dátovej množiny určenenej na detekciu nenávistnej reči. Výsledný model bol nahratý na Hugging Face pod menom `tetianamohorian/hate_speech_model` a je použitý v tejto aplikácii.
+- **Typ:** Encoder-decoder transformer, finetunovaný na binárnu klasifikáciu (toxický / neutrálny)
+
+
+## Použité knižnice
+
+- `transformers` – práca s Hugging Face modelmi
+
+- `torch` – tensorový backend
+
+- `flask` – API backend
+
+- `flask_cors` – povolenie CORS
+
+- `flask_caching` – cache výsledkov
+
+## Funkcionality
+
+Projekt demonštruje:
+
+- Nasadenie do cloudu (Railway) ✅
+
+- HTTPS certifikát ✅
+
+- Docker kontajnery pre frontend a backend ✅
+
+- Trvalé ukladanie predikcií (JSON) ✅
+
+- Automatické reštarty ✅
+
+- API testovanie ✅
+
+- Kvalitná dokumentácia ✅
+
+
+