Update README.md

README.md

@@ -1,13 +1,183 @@
+# 🛡️ IDS con Redes Neuronales — NSL-KDD
+
+**Proyecto Final | Materia: Redes Neuronales | Estudiante: César Núñez**
+
+Sistema de Detección de Intrusos (IDS) que clasifica tráfico de red usando dos modelos:
+- **MLP Base**: Clasificación binaria (Normal vs Ataque).
+- **Transfer Learning**: Clasificación multiclase en 5 categorías (Normal / DoS / Probe / R2L / U2R).
+
+---
+
+## 📁 Estructura del proyecto
+
+```
+proyecto_ids/
+│
+├── app/
+│   └── main.py               # API REST con FastAPI
+│
+├── notebooks/
+│   └── entrenamiento.ipynb   # Pipeline completo: EDA → preprocesamiento → modelos → métricas
+│
+├── models/                   # Artefactos generados por el notebook (NO subir a Git)
+│   ├── modelo_base.keras
+│   ├── modelo_transfer.keras
+│   ├── scaler.joblib
+│   └── encoders.joblib
+│
+├── data/                     # Dataset NSL-KDD (NO subir a Git)
+│   ├── train.csv
+│   └── test.csv
+│
+├── gradio_app.py             # Interfaz visual Gradio
+├── Dockerfile                # Imagen del servicio API
+├── Dockerfile.gradio         # Imagen del servicio Gradio
+├── docker-compose.yml        # Orquestación de ambos servicios
+├── requirements.txt          # Dependencias API
+├── requirements.gradio.txt   # Dependencias Gradio
+└── .gitignore
+```
+
+---
+
+## 🚀 Cómo ejecutar
+
+### ✅ Opción 1 — Docker Compose (recomendado)
+
+```bash
+# 1. Asegurarse de tener la carpeta models/ con los artefactos del notebook
+# 2. Construir y levantar ambos servicios
+docker compose up --build
+
+# La API estará disponible en:   http://localhost:8000
+# La interfaz Gradio estará en:  http://localhost:7860
+# La documentación Swagger en:   http://localhost:8000/docs
+```
+
+### ⚙️ Opción 2 — Ejecución manual (desarrollo)
+
+```bash
+# Crear y activar entorno virtual
+python -m venv venv
+source venv/bin/activate        # Linux/Mac
+venv\Scripts\activate           # Windows
+
+# Instalar dependencias
+pip install -r requirements.txt
+pip install gradio requests
+
+# Terminal 1: levantar la API
+uvicorn app.main:app --reload --port 8000
+
+# Terminal 2: levantar la interfaz
+python gradio_app.py
+```
+
+### 📓 Opción 3 — Solo el notebook
+
+```bash
+pip install -r requirements.txt jupyter
+jupyter notebook notebooks/entrenamiento.ipynb
+# Ejecutar todas las celdas en orden (Kernel → Restart & Run All)
+```
+
 ---
-title: Final Redes Neuronales
-emoji: 🚀
-colorFrom: yellow
-colorTo: red
-sdk: gradio
-sdk_version: 6.8.0
-app_file: app.py
-pinned: false
-short_description: 'Sistema de Detección de Intrusos (IDS) con Redes Neuronales '
+
+## 📡 Endpoints de la API
+
+| Método | Endpoint              | Descripción                              |
+|--------|-----------------------|------------------------------------------|
+| GET    | `/`                   | Bienvenida y health check básico         |
+| GET    | `/health`             | Verifica que los modelos estén cargados  |
+| POST   | `/predict/binary`     | Normal vs Ataque (MLP Base)              |
+| POST   | `/predict/multiclass` | 5 categorías (Transfer Learning)         |
+| GET    | `/docs`               | Documentación interactiva Swagger UI     |
+
+### Ejemplo de uso con `curl`
+
+```bash
+curl -X POST http://localhost:8000/predict/binary \
+  -H "Content-Type: application/json" \
+  -d '{"features": [0,2,30,10,491,0,0,0,0,0,0,1,0,0,0,0,0,0,0,0,0,0,2,2,0,0,0,0,1,0,0,150,25,0.17,0.03,0.17,0,0.01,0.06,0,0]}'
+```
+
+### Respuesta esperada
+
+```json
+{
+  "prediction": "Tráfico Normal ✅",
+  "probability": 0.0312,
+  "confidence": "96.9%",
+  "mode": "binary",
+  "status": "success"
+}
+```
+
+---
+
+## 🔧 Obtener el dataset NSL-KDD
+
+```bash
+# Descargar desde la fuente oficial
+wget https://www.unb.ca/cic/datasets/nsl.html
+# O usar la versión de Kaggle: search "NSL-KDD dataset"
+
+# Colocar los archivos en:
+mkdir -p data/
+# data/train.csv  → KDDTrain+.txt  (renombrar y mover)
+# data/test.csv   → KDDTest+.txt   (renombrar y mover)
+```
+
+---
+
+## 📊 Dataset — NSL-KDD
+
+| Característica      | Valor                        |
+|---------------------|------------------------------|
+| Registros Train     | ~125,973                     |
+| Registros Test      | ~22,544                      |
+| Variables (features)| 41                           |
+| Clases binarias     | Normal / Ataque              |
+| Clases multiclase   | Normal, DoS, Probe, R2L, U2R |
+| Año de referencia   | 1999 (benchmark académico)   |
+
+---
+
+## ⚙️ Stack tecnológico
+
+| Componente      | Tecnología                  |
+|-----------------|-----------------------------|
+| Modelos         | TensorFlow / Keras          |
+| Preprocesamiento| Scikit-learn                |
+| API REST        | FastAPI + Uvicorn           |
+| Interfaz visual | Gradio                      |
+| Contenerización | Docker + Docker Compose     |
+| Control versiones| Git + GitHub               |
+
+---
+
+## .gitignore recomendado
+
+```gitignore
+# Modelos entrenados (archivos pesados)
+models/*.keras
+models/*.joblib
+models/*.h5
+models/*.png
+
+# Dataset
+data/
+
+# Entorno virtual
+venv/
+__pycache__/
+*.pyc
+.ipynb_checkpoints/
+
+# Variables de entorno
+.env
+```
+
 ---
 
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+*César Núñez — Proyecto Final, Materia: Redes Neuronales*