fix README

README.md

@@ -1,91 +1,102 @@
+---
+title: RAG QA System
+emoji: 🤖
+colorFrom: indigo
+colorTo: blue
+sdk: gradio
+sdk_version: "6.9.0"
+app_file: app.py
+pinned: false
+---
+
 # RAG Question Answering System
 
-Sistema de preguntas y respuestas basado en Retrieval-Augmented
-Generation (RAG) que utiliza una pequeña base de conocimiento en inglés
-almacenada en `documents.json`.
+Sistema de preguntas y respuestas basado en **Retrieval-Augmented Generation (RAG)** que utiliza una pequeña base de conocimiento en inglés almacenada en `documents.json`.
+
+La aplicación permite realizar preguntas en inglés y obtiene la respuesta utilizando:
 
-La aplicación permite realizar preguntas en inglés y obtiene la
-respuesta utilizando: - Recuperación de documentos relevantes mediante
-embeddings. - Generación de respuesta usando un modelo de lenguaje. -
-Una interfaz web interactiva desarrollada con **Gradio**.
+- Recuperación de documentos relevantes mediante embeddings.
+- Generación de respuesta usando un modelo de lenguaje.
+- Una interfaz web interactiva desarrollada con **Gradio**.
 
-------------------------------------------------------------------------
+---
 
-## Estructura del proyecto
+# Estructura del proyecto
+
+```text
+app.py
+rag_engine.py
+documents.json
+requirements.txt
+README.md
+/tests
+    test_api.py
+```
 
-    app.py
-    rag_engine.py
-    documents.json
-    requirements.txt
-    README.md
-    /tests
-        test_api.py
+**Descripción de los archivos:**
 
--   **app.py**: interfaz web con Gradio.
--   **rag_engine.py**: lógica del sistema RAG (recuperación de
-    documentos y generación de respuestas).
--   **documents.json**: base de conocimiento utilizada por el sistema.
--   **requirements.txt**: dependencias necesarias para ejecutar el
-    proyecto.
--   **tests/test_api.py**: script para probar la API del sistema
-    desplegado.
+- **app.py** → interfaz web construida con Gradio.
+- **rag_engine.py** → lógica del sistema RAG (recuperación de documentos y generación de respuestas).
+- **documents.json** → base de conocimiento usada por el chatbot.
+- **requirements.txt** → dependencias necesarias para ejecutar el proyecto.
+- **tests/test_api.py** → script para probar la API del sistema desplegado.
 
-------------------------------------------------------------------------
+---
 
-## Instalación
+# Instalación
 
-Clonar el repositorio o descargar los archivos y crear un entorno
-virtual:
+Clonar el repositorio o descargar los archivos y crear un entorno virtual.
 
-``` bash
+```bash
 python3 -m venv .venv
 source .venv/bin/activate
 ```
 
 Instalar las dependencias:
 
-``` bash
+```bash
 pip install -r requirements.txt
 ```
 
-------------------------------------------------------------------------
+---
 
-## Ejecución local
+# Ejecución local
 
 Para ejecutar la aplicación localmente:
 
-``` bash
+```bash
 python app.py
 ```
 
-Luego abrir el navegador en:
+Abrir el navegador en:
 
-    http://127.0.0.1:7860
+```text
+http://127.0.0.1:7860
+```
 
-Desde la interfaz se pueden realizar preguntas en inglés sobre la base
-de conocimiento.
+Desde la interfaz se pueden realizar preguntas en inglés sobre la base de conocimiento.
 
-------------------------------------------------------------------------
+---
 
-## Despliegue
+# Despliegue
 
-La aplicación está desplegada en **Hugging Face Spaces** utilizando el
-SDK de Gradio.
+La aplicación está desplegada en **Hugging Face Spaces** usando el SDK de **Gradio**.
 
 URL del Space:
 
+```text
 https://adrianpalmadev-rag-qa-system.hf.space
+```
 
-------------------------------------------------------------------------
+---
 
-## Uso de la API
+# Uso de la API
 
-El sistema también puede utilizarse mediante la API generada
-automáticamente por Gradio.
+El sistema también puede utilizarse mediante la API generada automáticamente por Gradio.
 
 Ejemplo de cliente en Python:
 
-``` python
+```python
 from gradio_client import Client
 
 client = Client("https://adrianpalmadev-rag-qa-system.hf.space")
@@ -100,16 +111,18 @@ result = client.predict(
 print(result)
 ```
 
-Este script devuelve: - La respuesta generada por el modelo. - Los
-documentos recuperados utilizados como contexto.
+Este script devuelve:
+
+- La respuesta generada por el modelo.
+- Los documentos recuperados utilizados como contexto.
 
-------------------------------------------------------------------------
+---
 
-## Tecnologías utilizadas
+# Tecnologías utilizadas
 
--   Python
--   Transformers
--   Sentence Transformers
--   Scikit-learn
--   Gradio
--   Hugging Face Spaces
+- Python
+- Transformers
+- Sentence Transformers
+- Scikit-learn
+- Gradio
+- Hugging Face Spaces