Skip to content

Latest commit

 

History

History
454 lines (309 loc) · 15.9 KB

README_ES.md

File metadata and controls

454 lines (309 loc) · 15.9 KB

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

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


Q&A de Documentos y Resolución de Problemas Paso a Paso

🎨 Visualización de Aprendizaje Interactivo


Aprendizaje de IA Interactivo con Explicaciones Visuales del Conocimiento

🎯 Refuerzo de Conocimiento

Preguntas Personalizadas
Preguntas de Práctica Auto-Validadas con Retroalimentación Instantánea

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

🔍 Investigación Profunda y Generación de Ideas

Investigación Profunda
Búsqueda Web y de Artículos con Revisión de Literatura

IdeaGen Automatizado
Lluvia de Ideas Sistemática y Síntesis de Conceptos

IdeaGen Interactivo
Generación de Ideas Impulsada por RAG con Perspectivas Multi-Fuente

🏗️ 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!

  • Aprendizaje basado en proyectos
  • Codificación profunda desde generación de ideas
  • Memoria personalizada
  • Opción alternativa con RAG ingenuo

🚀 Inicio Rápido

Paso 1: Clonar y Crear Entorno Virtual

# Clonar el repositorio
git clone https://github.com/HKUDS/DeepTutor.git
cd DeepTutor

# Crear entorno virtual (elegir un método)

# Opción A: Usando conda (Recomendado)
conda create -n aitutor python=3.10
conda activate aitutor

# Opción B: Usando venv
python -m venv venv
# En Windows:
venv\Scripts\activate
# En macOS/Linux:
source venv/bin/activate

Paso 2: Instalar Dependencias

Ejecute el script de instalación de un clic para instalar automáticamente todas las dependencias:

# Recomendado: Usar script bash
bash scripts/install_all.sh

# Alternativa: Usar script Python
python scripts/install_all.py

# O instalar manualmente
pip install -r requirements.txt
npm install

Paso 3: Configurar Variables de Entorno

Cree un archivo .env en el directorio raíz del proyecto basado en .env.example:

# Copiar de plantilla .env.example (si existe)
cp .env.example .env

# Luego edite el archivo .env con sus claves de API:

Paso 4: Configurar Puertos (Opcional)

Por defecto, la aplicación utiliza:

  • Backend (FastAPI): 8001
  • Frontend (Next.js): 3782

Puede modificar estos puertos en config/main.yaml editando los valores server.backend_port y server.frontend_port.

Paso 5: Usar Nuestras Demostraciones (Opcional)

Para experimentar rápidamente nuestro sistema, proporcionamos dos bases de conocimiento preprocesadas junto con una colección de preguntas desafiantes y ejemplos de uso.

Colección de Artículos de Investigación — 5 artículos (20-50 páginas cada uno)

Una colección seleccionada de 5 artículos de investigación en campos RAG y Agent de nuestro laboratorio. Esta demostración representa escenarios con amplia cobertura de conocimiento para propósitos de investigación.

Artículos Utilizados: AI-Researcher | AutoAgent | RAG-Anything | LightRAG | VideoRAG

Libro de Texto de Ciencia de Datos — 8 capítulos, 296 páginas

Un libro de texto de ciencia de datos integral y desafiante. Esta demostración representa escenarios con profundidad de conocimiento profunda para propósitos de aprendizaje.

Enlace del Libro: Deep Representation Learning Book


Descargar y Configurar:

  1. Descargue el paquete de demostración desde: Google Drive
  2. Extraiga los archivos comprimidos directamente en el directorio data/
  3. Las bases de conocimiento estarán disponibles automáticamente en el sistema después de iniciar el proyecto

Nota: Utilizamos text-embedding-3-large como modelo de incrustaciones al inicializar nuestras bases de conocimiento, con dimensions = 3072. Asegúrese de que las dimensiones de su modelo de incrustaciones también sean 3072.

Paso 6: Iniciar la Aplicación

# Asegúrese de que el entorno virtual esté activado
conda activate aitutor  # o: source venv/bin/activate

# Iniciar interfaz web (frontend + backend)
python scripts/start_web.py

# O iniciar solo la interfaz CLI
python scripts/start.py

# Para detener el servicio, presione Ctrl+C

Paso 7: Crear su Propia Base de Conocimiento

Después de iniciar la aplicación, puede crear su propia base de conocimiento a través de la interfaz web, bajo cualquier modalidad.

  1. Acceder a la Página de Base de Conocimiento: Visite http://localhost:{frontend_port}/knowledge
  2. Crear Nueva Base de Conocimiento: Haga clic en el botón "New Knowledge Base"
  3. Nombrar su Base de Conocimiento: Ingrese un nombre único para su base de conocimiento
  4. Cargar Archivos: Cargue uno o múltiples archivos
  5. Esperar el Procesamiento: El sistema procesará automáticamente sus archivos en segundo plano
    • Monitoree el progreso de creación en la terminal donde se está ejecutando start_web.py
    • La base de conocimiento estará disponible una vez que se complete el procesamiento

Consejos: Los archivos grandes pueden tardar varios minutos en procesarse. Puede cargar múltiples archivos a la vez para procesamiento por lotes.

URLs de Acceso

Servicio URL Descripción
Frontend http://localhost:{frontend_port} Interfaz web principal
Documentación API http://localhost:{backend_port}/docs Documentación de API interactiva
Salud http://localhost:{backend_port}/api/v1/knowledge/health Verificación de salud del sistema

📄 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