Skip to content

SergioPulidoC/OpenCVPythonRAG

Repository files navigation

OpenCVPythonRAG

Overview

OpenCVPythonRAG is a project aimed at building a Retrieval-Augmented Generation (RAG) system using OpenCV's Python documentation as the knowledge base. The goal is to create an interactive tool that can answer questions and provide code suggestions from the OpenCV documentation, leveraging natural language understanding. One of the RAG's main features is being Python-tailored, meaning that it will do its best to give a relevant answer to Python-related inquiries, avoiding the use of C++.

Features

  • Automated extraction of OpenCV's Python documentation.
  • Preprocessing of documentation for efficient retrieval.
  • Embedding generation for natural language querying.
  • RAG pipeline setup for question-answering.

Installation

To get started, you'll need Python 3.8+ and a few Python libraries.

  1. Clone the repository:
git clone https://github.com/SergioPulidoC/OpenCVPythonRAG.git
cd OpenCVPythonRAG
  1. Set up a virtual environment:
python3 -m venv venv
# For Linux:
source venv/bin/activate
# If you're on Windows, use:
# venv\Scripts\activate
  1. Install the required packages:
pip install -r requirements.txt

Usage

[Work in progress!]

Roadmap

  • Basic setup and README
  • Documentation extraction
  • Embedding generation and storage
  • RAG pipeline implementation
  • Testing and deployment

Contribute

Contributions are welcome! Feel free to submit a pull request or open an issue for discussion.

License

This project is licensed under the MIT License. Check the LICENSE for more information.

About

A Retrieval-Augmented Generation (RAG) project leveraging OpenCV’s Python documentation as a knowledge base to provide natural language answers and code suggestions.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors