Skip to content

Latest commit

 

History

History
85 lines (60 loc) · 3.46 KB

README.md

File metadata and controls

85 lines (60 loc) · 3.46 KB
Raw

NeoGPT 🚀

Say goodbye to boring interactions with documents and YouTube videos. NeoGPT is your trusted companion to chat with local documents and lengthy YouTube videos effortlessly. Perfect for professionals, developers, researchers, and enthusiasts.

Note: NeoGPT is continuously evolving. Your feedback shapes its future.

🎉 Join Us for Hacktoberfest 2023

Hacktoberfest Banner

🚀 Getting Started

  1. Installation: Clone this repository and install the necessary dependencies.

    git clone https://github.com/neokd/NeoGPT.git
cd NeoGPT
pip install -r requirements.txt

  2. Building Database Currently NeoGPT supports local files and Youtube videos. To build the database add your local files to the documents directory and URL in the builder.url file. Then run the builder script.

        python builder.py

    This will create a database file in the db folder. You can also specify the database to use --db flag. Supported databases are:

    • Chroma (default)
    • FAISS
    • Pinecone (experimental)

    Currently the database is built using 2 papers:

  3. Run NeoGPT: Run the CLI to start using NeoGPT. Requires Python v3.10. You can use the --help flag to view the available commands and options.

        python main.py

Supported Retriever

  • Local Retriever
  • Web Retriever
  • Hybrid Retriever (Ensemble Retriever)

✅ Achievements

  • ✓ RAG (Question Answering with local files) 📂
  • ✓ Chat with Youtube Videos 🎥
  • ✓ Web Based RAG (Search on Web and local files) 🌐📂
  • ✓ Hybrid RAG (Keyword based and Semmantic Search) 🕵️‍♂️📂
  • ✓ FAISS Support 📊
  • ✓ Chromadb Support 🎵
  • ☐ User Interface 💻
  • ☐ Build a user-friendly CLI ⌨️
  • ☐ Upgrade Builder to support multiple file types including URLs 📦🌐
  • ☐ Add support for other LLM types (Ollama) 🧠
  • ☐ Add other database support (MongoDB, ElasticSearch, etc.) 📁🔍
  • ☐ Support for other search engines (DuckDuckGo, Bing, etc.) 🔍
  • ☐ Docker Support 🐳
  • ☐ Better Documentation 📖
  • ☐ Agent based chatbot 🤖

🌟 Features

  • Task Automation: NeoGPT can automate a wide range of tasks, from text generation to data analysis, making it a versatile tool for various domains.

  • Local Execution: NeoGPT runs entirely on your local system, ensuring data privacy and security.

  • User-Friendly Interface: NeoGPT is designed with a user-friendly command-line interface (CLI) that makes it accessible to users with varying levels of technical expertise.

  • Extensible: You can easily extend NeoGPT's functionality by adding custom plugins or scripts.

🔬 Experimental

Explore our multi-agent bot that generates responses based on a single user prompt. This experimental project showcases the capabilities of NeoGPT.

👥 Contributing

We welcome contributions to NeoGPT! If you have ideas for new features or improvements, please open an issue or submit a pull request. For more information, see our contributing guide.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details. Let's innovate together! 🤖✨