Skip to content

README_ES.md

Latest commit

 

History

History
532 lines (371 loc) · 17.3 KB

README_ES.md

File metadata and controls

532 lines (371 loc) · 17.3 KB

| ⚡ Q&A de Conocimiento de Documentos Masivos | 📈 Visualización de Aprendizaje Interactivo |
| 🧠 Refuerzo de Conocimiento | 🔬 Investigación Profunda y Generación de Ideas |

[2026.1.1] ¡Feliz Año Nuevo! Únete a nuestra Comunidad de Discord, Comunidad de WeChat o Discussions — ¡moldea el futuro de DeepTutor! 💬

[2025.12.30] ¡Visita nuestro Sitio Web Oficial para más detalles!

[2025.12.29] ¡DeepTutor ya está disponible! ✨

Características Clave de DeepTutor

📚 Q&A de Conocimiento de Documentos Masivos

• Base de Conocimiento Inteligente: Sube libros de texto, artículos de investigación, manuales técnicos y documentos específicos del dominio. Construye un repositorio de conocimiento completo impulsado por IA para acceso instantáneo.
• Resolución de Problemas Multi-Agente: Arquitectura de razonamiento de doble bucle con RAG, búsqueda web, búsqueda de artículos y ejecución de código—entregando soluciones paso a paso con citas precisas.

🎨 Visualización de Aprendizaje Interactivo

• Simplificación y Explicaciones del Conocimiento: Transforma conceptos complejos, conocimiento y algoritmos en ayudas visuales fáciles de entender, desgloses detallados paso a paso y demostraciones interactivas atractivas.
• Q&A Personalizado: Conversaciones conscientes del contexto que se adaptan a tu progreso de aprendizaje, con páginas interactivas y seguimiento de conocimiento basado en sesiones.

🎯 Refuerzo de Conocimiento con Generador de Problemas de Práctica

• Creación de Ejercicios Inteligentes: Genera cuestionarios dirigidos, problemas de práctica y evaluaciones personalizadas adaptadas a tu nivel actual de conocimiento y objetivos de aprendizaje específicos.
• Simulación de Examen Auténtica: Sube exámenes de referencia para generar preguntas de práctica que coincidan perfectamente con el estilo, formato y dificultad originales—dándote una preparación realista para el examen real.

🔍 Investigación Profunda y Generación de Ideas

• Investigación Integral y Revisión de Literatura: Realiza exploración profunda de temas con análisis sistemático. Identifica patrones, conecta conceptos relacionados entre disciplinas y sintetiza hallazgos de investigación existentes.
• Descubrimiento de Ideas Novedosas: Genera materiales de aprendizaje estructurados y descubre brechas de conocimiento. Identifica nuevas direcciones de investigación prometedoras a través de síntesis inteligente de conocimiento entre dominios.

All-in-One Tutoring System

📚 Q&A de Conocimiento de Documentos Masivos


Resolución de Problemas Multi-Agente con Citas Exactas

🎨 Visualización de Aprendizaje Interactivo


Explicaciones Visuales Paso a Paso con Q&A Personalizado

🎯 Refuerzo de Conocimiento

Preguntas Personalizadas
Generación de Preguntas de Práctica Auto-Validadas

Preguntas de Imitación
Clonar Estilo de Examen para Práctica Auténtica

🔍 Investigación Profunda y Generación de Ideas

Investigación Profunda
Extensión del Conocimiento desde el Libro de Texto con RAG, Web y Búsqueda de Artículos

IdeaGen Automatizado
Lluvia de Ideas Sistemática y Síntesis de Conceptos con Flujo de Trabajo de Doble Filtro

IdeaGen Interactivo
Co-Writer Impulsado por RAG y Búsqueda Web con Generación de Podcasts

🏗️ Sistema de Conocimiento Todo en Uno

Base de Conocimiento Personal
Construye y Organiza Tu Propio Repositorio de Conocimiento

Cuaderno Personal
Tu Memoria Contextual para Sesiones de Aprendizaje

🌙 ¡Usa DeepTutor en Modo Oscuro!

Arquitectura del Sistema

DeepTutor Full-Stack Workflow

📋 Tareas Pendientes

¡Síguenos para nuestras futuras actualizaciones!

  • Soporte para servicios LLM locales (ej. ollama)
  • Refactorización del módulo RAG (ver Discussions)
  • Codificación profunda desde generación de ideas
  • Interacción personalizada con el cuaderno

🚀 Inicio Rápido

Paso 1: Preconfiguración

① Clonar Repositorio

git clone https://github.com/HKUDS/DeepTutor.git
cd DeepTutor

② Configurar Variables de Entorno

cp .env.example .env
# Edite el archivo .env con sus claves de API
📋 Referencia de Variables de Entorno
Variable Requerido Descripción
LLM_MODEL Sí Nombre del modelo (ej: gpt-4o)
LLM_API_VERSION No Versión de API para Azure OpenAI (ej: 2024-02-15-preview)
LLM_API_KEY Sí Su clave API de LLM
LLM_HOST Sí URL del endpoint de API
EMBEDDING_MODEL Sí Nombre del modelo de incrustación
EMBEDDING_API_VERSION No Versión de API para Azure OpenAI Embeddings
EMBEDDING_API_KEY Sí Clave API de incrustación
EMBEDDING_HOST Sí Endpoint de API de incrustación
BACKEND_PORT No Puerto del backend (predeterminado: 8001)
FRONTEND_PORT No Puerto del frontend (predeterminado: 3782)
NEXT_PUBLIC_API_BASE No URL del API para el frontend (configúrelo para acceso remoto/LAN, ej: http://192.168.1.100:8001)
TTS_* No Configuración de texto a voz
SEARCH_PROVIDER No Proveedor de búsqueda (opciones: perplexity, tavily, serper, jina, exa, baidu, predeterminado: perplexity)
SEARCH_API_KEY No Clave API unificada para búsqueda

💡 Acceso remoto: si accede desde otro dispositivo (ej.: 192.168.31.66:3782), añada a .env:

NEXT_PUBLIC_API_BASE=http://192.168.31.66:8001

③ Configurar Puertos y LLM (Opcional)

  • Puertos: Configure en .env → BACKEND_PORT / FRONTEND_PORT (predeterminado: 8001/3782)
  • LLM: Edite config/agents.yaml → temperature / max_tokens por módulo
  • Consulte Documentación de Configuración para más detalles

④ Probar Bases de Conocimiento Demo (Opcional)

📚 Demos Disponibles
  • Artículos de Investigación — 5 artículos de nuestro laboratorio (AI-Researcher, LightRAG, etc.)
  • Libro de Texto de Ciencia de Datos — 8 capítulos, 296 páginas (Enlace del Libro)
  1. Descargar desde Google Drive
  2. Extraer al directorio data/

Los KBs demo usan text-embedding-3-large con dimensions = 3072

⑤ Crear su Propia Base de Conocimiento (Después del Inicio)

  1. Ir a http://localhost:3782/knowledge
  2. Hacer clic en "New Knowledge Base" → Ingresar nombre → Subir archivos PDF/TXT/MD
  3. Monitorear el progreso en la terminal

Paso 2: Elija su Método de Instalación

🐳 Despliegue Docker

Recomendado — Sin configuración de Python/Node.js

Prerrequisitos: Docker y Docker Compose

🚀 Opción A: Imagen Pre-construida (Más Rápido) 
# Funciona en todas las plataformas: Docker detecta automáticamente su arquitectura
docker run -d --name deeptutor \
  -p 8001:8001 -p 3782:3782 \
  --env-file .env \
  -v $(pwd)/data:/app/data \
  -v $(pwd)/config:/app/config:ro \
  ghcr.io/hkuds/deeptutor:latest

# Windows PowerShell: use ${PWD} en lugar de $(pwd)

O usar archivo .env:

docker run -d --name deeptutor \
  -p 8001:8001 -p 3782:3782 \
  --env-file .env \
  -v $(pwd)/data:/app/data \
  -v $(pwd)/config:/app/config:ro \
  ghcr.io/hkuds/deeptutor:latest
🔨 Opción B: Construir desde Código Fuente 
# Construir e iniciar (~5-10 min primera ejecución)
docker compose up --build -d

# Ver logs
docker compose logs -f

Comandos:

docker compose up -d      # Iniciar
docker compose logs -f    # Logs
docker compose down       # Detener
docker compose up --build # Reconstruir
docker pull ghcr.io/hkuds/deeptutor:latest  # Actualizar imagen

Modo Dev: Agregar -f docker-compose.dev.yml

💻 Instalación Manual

Para desarrollo o entornos no Docker

Prerrequisitos: Python 3.10+, Node.js 18+

Configurar Entorno:

# Usando conda (Recomendado)
conda create -n deeptutor python=3.10
conda activate deeptutor

# O usando venv
python -m venv venv
source venv/bin/activate

Instalar Dependencias:

# Instalación con un clic (Recomendado)
python scripts/install_all.py
# O: bash scripts/install_all.sh

# O instalación manual
pip install -r requirements.txt
npm install --prefix web

Iniciar:

# Iniciar interfaz web
python scripts/start_web.py

# O solo CLI
python scripts/start.py

# Detener: Ctrl+C

URLs de Acceso

Servicio URL Descripción
Frontend http://localhost:3782 Interfaz web principal
Documentación API http://localhost:8001/docs Documentación de API interactiva

📄 Licencia

📄 Licencia

Este proyecto está licenciado bajo la AGPL-3.0.

⭐ Historial de Stars

🤝 Contribución

¡Bienvenemos contribuciones de la comunidad! Para garantizar la calidad y consistencia del código, siga las directrices a continuación.

Configuración de Desarrollo

Configuración de Pre-commit Hooks

Este proyecto utiliza pre-commit hooks para formatear automáticamente el código y verificar problemas antes de comprometer.

Paso 1: Instalar pre-commit

# Usando pip
pip install pre-commit

# O usando conda
conda install -c conda-forge pre-commit

Paso 2: Instalar Git hooks

cd DeepTutor
pre-commit install

Paso 3: (Opcional) Ejecutar verificaciones en todos los archivos

pre-commit run --all-files

Cada vez que ejecute git commit, pre-commit hooks ejecutará automáticamente:

  • Formatear código Python con Ruff
  • Formatear código frontend con Prettier
  • Verificar errores de sintaxis
  • Validar archivos YAML/JSON
  • Detectar posibles problemas de seguridad

Herramientas de Calidad de Código

Herramienta Propósito Configuración
Ruff Verificación y formato de código Python pyproject.toml
Prettier Formato de código frontend web/.prettierrc.json
detect-secrets Verificación de seguridad .secrets.baseline

Nota: El proyecto usa Ruff format en lugar de Black para evitar conflictos de formato.

Comandos Comunes

# Commit normal (hooks se ejecutan automáticamente)
git commit -m "Su mensaje de commit"

# Verificar manualmente todos los archivos
pre-commit run --all-files

# Actualizar hooks a versiones más recientes
pre-commit autoupdate

# Saltar hooks (no recomendado, solo para emergencias)
git commit --no-verify -m "Corrección de emergencia"

Directrices de Contribución

  1. Fork y Clone: Fork el repositorio y clonelo
  2. Crear Rama: Crear una rama de función desde main
  3. Instalar Pre-commit: Seguir los pasos de configuración anteriores
  4. Realizar Cambios: Escribir código siguiendo el estilo del proyecto
  5. Probar: Asegurar que sus cambios funcionan correctamente
  6. Commit: Pre-commit hooks formateará automáticamente su código
  7. Push y PR: Empujar a su fork y crear una Pull Request

Reportar Problemas

  • Usar GitHub Issues para reportar bugs o sugerir características
  • Proporcionar información detallada sobre el problema
  • Si es un bug, incluir pasos para reproducir

❤️ Agradecemos a todos nuestros contribuyentes por sus valiosas contribuciones.

🔗 Proyectos Relacionados

⚡ LightRAG 🎨 RAG-Anything 💻 DeepCode 🔬 AI-Researcher
RAG Simple y Rápido RAG Multimodal Asistente de Código AI Automatización de Investigación

Laboratorio de Inteligencia de Datos @ HKU

⭐ Síguenos · 🐛 Reportar un bug · 💬 Discusiones

✨ ¡Gracias por visitar DeepTutor!

Views