easyrag-python 1.0.0

EasyRAG Python Package

---

EasyRAG Python Package

RAG is a Python package designed to facilitate information retrieval and generation tasks, particularly in natural language processing applications. With RAG, users can input a PDF file along with a Hugging Face model, enabling the extraction of relevant data from the PDF and responding to user queries based on the extracted information.

Features

• PDF Parsing: RAG can parse PDF files to extract textual information.
• Information Retrieval: Using Hugging Face models, RAG retrieves relevant data from the parsed PDF.
• Query Response: Users can ask questions or input queries, and RAG will provide responses based on the extracted information.

Installation

To install rag, paste the link below into your terminal and press enter.

pip install git+https://github.com/SayedShaun/easyrag.git

Usage

Using RAG is straightforward. Here's a basic example of how to use it:

from easyrag import HuggingFaceModel

# Initialize and Provide a PDF file and Hugging Face model
rag = HuggingFaceModel(
    model_id="meta-llama/Meta-Llama-3-8B-Instruct",
    hf_token="your huggingface token",
    pdf_path="sample resume.pdf"
)

# Retrieve data from the PDF
rag.retrieve_answer("what skills she has?")

# Response
"""
Donna Robbins has skills in Microsoft NAV Dynamics,
Cashflow planning & management, State & federal tax codes,
Bookkeeping, Exceptional communication, and Fluent in German.
"""

Bugs

The "Rag" framework is designed for quick rag prototype and to check retrieval performance with different open source models, including Llama, Mistral, Phi, and other 1 to 10 billion parameter models. It also supports Googgle Gemini and OpenAi models through API call. All open-source models might not be compatible also the GoogleGemini and OpenAI classes are unstable at this moment.

Contributing

We welcome contributions from the community to enhance RAG's functionality, improve its performance, or fix any issues. To contribute, please follow these steps:

License

This project is licensed under the MIT License - see the LICENSE file for details.

---