morenomp commited on
Commit
506d8f8
·
unverified ·
1 Parent(s): 5ac738d

Initialize README with project details and setup

Browse files
Files changed (1) hide show
  1. README.md +64 -0
README.md ADDED
@@ -0,0 +1,64 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ## 📌 Descripción del proyecto
2
+
3
+ Este proyecto implementa un sistema de preguntas y respuestas basado en la técnica **RAG (Retrieval-Augmented Generation)**.
4
+
5
+ El sistema permite al usuario hacer preguntas en inglés sobre una base de conocimiento (documents.json), y genera respuestas utilizando modelos de inteligencia artificial.
6
+
7
+ El proyecto incluye:
8
+ - Un motor RAG (rag_engine.py)
9
+ - Una interfaz web interactiva con Gradio (app.py)
10
+ - Una base de conocimiento en formato JSON
11
+ - Acceso mediante API
12
+
13
+ ---
14
+
15
+ ## ⚙️ Tecnologías utilizadas
16
+
17
+ - Python
18
+ - Transformers (HuggingFace)
19
+ - Sentence Transformers
20
+ - Scikit-learn
21
+ - Gradio
22
+
23
+ Modelos utilizados:
24
+ - Embeddings: `MongoDB/mdbr-leaf-ir`
25
+ - LLM: `microsoft/Phi-2`
26
+
27
+ ---
28
+
29
+ ## 🧠 ¿Cómo funciona el sistema?
30
+
31
+ El sistema sigue estos pasos:
32
+
33
+ 1. El usuario introduce una pregunta
34
+ 2. Se convierte la pregunta en un embedding (vector)
35
+ 3. Se comparan los embeddings con los documentos
36
+ 4. Se seleccionan los documentos más relevantes
37
+ 5. Se construye un prompt con contexto
38
+ 6. El modelo genera una respuesta basada en ese contexto
39
+
40
+ ---
41
+
42
+ ## 📂 Estructura del proyecto
43
+
44
+ Python-Huggingface/
45
+
46
+ ├── app.py # Interfaz con Gradio
47
+ ├── rag_engine.py # Lógica del sistema RAG
48
+ ├── documents.json # Base de conocimiento
49
+ ├── requirements.txt # Dependencias
50
+
51
+ └── test/
52
+ ├── test_api.py
53
+ └── test-api-space.py
54
+
55
+ ---
56
+
57
+ ## 🚀 Instalación
58
+
59
+ 1. Clonar el repositorio o descargar los archivos
60
+
61
+ 2. Instalar dependencias:
62
+
63
+ ```bash
64
+ pip install -r requirements.txt