SimpleRAGHuggingFace 0.1.0

A simple Retrieval-Augmented Generation (RAG) library using Hugging Face datasets.

Simple RAG HuggingFace

Descripción

Diseñado para implementar sistemas de generación aumentada con recuperación de información. Utiliza datasets de Hugging Face, los vectoriza y permite consultas rápidas basadas en similitud de coseno.

Instalación

pip install SimpleRAGHuggingFace

Uso

Configuración Inicial

En la primera ejecución, se realiza la carga del dataset, su vectorización, y el almacenamiento de los embeddings:

from rag import Rag

# Configurar el sistema con un dataset de Hugging Face
rag = Rag(hf_dataset="JulianVelandia/unal-repository-dataset")

Esto genera:

• Base de datos original: Almacenada en memoria como lista de documentos.
• Base de datos vectorizada: Archivo .npy en la carpeta embeddings/.

Consulta y Recuperación

Una vez configurado, puedes realizar consultas:

query = "¿Cuál es el Diseño de iluminación, control y embellecimiento de la cancha del Estadio Alfonso López?"
response = rag.retrieval_augmented_generation(query)
print(response)

El resultado será el prompt inicial combinado con las secciones más relevantes del contexto:

¿Cuál es el Diseño de iluminación, control y embellecimiento de la cancha del Estadio Alfonso López?

Keep in mind this context:
Diseño de iluminación ... el Estadio Alfonso López, así como los resultados obtenidos, entendiendo que un equipo de futbol ...
...

Flujo de Trabajo

1. Setup (Preprocesamiento):

   • Carga el dataset desde Hugging Face.
   • Vectoriza los documentos usando TF-IDF.
   • Guarda los embeddings en formato .npy.

   Dataset HF -> Carga -> Vectorización -> Embeddings (.npy)
   

2. Querying (Consulta):

   • Vectoriza el prompt.
   • Calcula similitudes coseno entre el prompt y los documentos vectorizados.
   • Recupera las secciones más relevantes.
   • Combina el prompt con el contexto recuperado.

   Prompt -> Vectorización -> Similitud coseno -> Recuperación -> Contexto combinado