Skip to content

Commit

Permalink
Create README.md for RAG on pdf
Browse files Browse the repository at this point in the history
  • Loading branch information
akashAD98 authored Dec 20, 2024
1 parent 49defe3 commit 466ad2d
Showing 1 changed file with 44 additions and 0 deletions.
44 changes: 44 additions & 0 deletions examples/RAG-On-PDF/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# FarmerGPT: RAG with PDF for Farmer Data

This project demonstrates how to build a Retrieval-Augmented Generation (RAG) application using farmer-specific data. The data is extracted from a PDF containing crop variety information for sugarcane, turmeric, bamboo, cashew nuts, and more. The application leverages **LangChain** and **LanceDB** to create a customizable and extensible FarmerGPT solution.

---

## Features

- **Customizable Prompts**: Easily adapt prompts to suit specific queries and use cases.
- **Memory Support**: Incorporates memory capabilities to retain context during interactions.
- **PDF Integration**: Processes and retrieves data from the provided PDF file.

---

## How to Use

. **Use the Colab Notebook**:
- To try FarmerGPT directly without setup, use the provided Google Colab notebook: <a href="https://colab.research.google.com/github/lancedb/vectordb-recipes/blob/main/examples/RAG-On-PDF
/main.ipynb"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"></a>
- Open the notebook, follow the instructions, and run the cells to interact with the application.

---

## Key Technologies

- **LangChain**: Framework for building applications powered by large language models.
- **LanceDB**: Vector database used for efficient document retrieval.
---

## Sample Use Cases

- Assisting farmers with queries about crop varieties.
- Providing tailored advice based on specific crop information.
- Serving as a reference for agricultural experts and enthusiasts.
---

## Customization

You can build upon this template to include:
- Additional crop varieties.
- New functionalities such as integration with IoT devices.
- Multi-language support for wider accessibility.

---

0 comments on commit 466ad2d

Please sign in to comment.