Awesome
<p align="center"> <img src="https://github.com/alexpinel/Dot/assets/93524949/9ab51fa9-3471-427f-b932-c001bac35346" alt="Dot App Banner"> </p> <p align="center"> <img src="https://img.shields.io/badge/license-GPL3.0-brightgreen.svg?style=flat-square" alt="License"> <img src="https://img.shields.io/github/v/release/alexpinel/Dot?style=flat-square" alt="GitHub release (latest by date)"> <img src="https://img.shields.io/github/commits-since/alexpinel/Dot/latest.svg?style=flat-square" alt="GitHub commits"> <img src="https://img.shields.io/github/stars/alexpinel/Dot.svg?style=social&label=Star&style=flat-square" alt="GitHub stars"> </p> <p align="center"> <strong><a href="https://dotapp.uk/">Visit the Dot Website</a></strong> </p>🚀 About Dot
Dot is a standalone, open-source application designed for seamless interaction with documents and files using local LLMs and Retrieval Augmented Generation (RAG). It is inspired by solutions like Nvidia's Chat with RTX, providing a user-friendly interface for those without a programming background. Using the Phi-3.5 LLM by default, Dot ensures accessibility and simplicity right out of the box.
https://github.com/alexpinel/Dot/assets/93524949/28b26128-7bdc-4bf7-99f3-d09bd8431875
📜 What does it do?
Dot allows you to load multiple documents into an LLM and interact with them in a fully local environment. Supported document types include PDF, DOCX, PPTX, XLSX, and more! Users can also engage with Big Dot for inquiries not directly related to their documents, similar to interacting with ChatGPT.
🔧 How does it work?
Built with Electron JS, The application uses libraries such as FAISS for creating local vector stores, Langchain, llama.cpp & Huggingface for setting up conversation chains, and additional tools for document management and interaction.
📥 Install
To use Dot:
- Visit the Dot website to download the application for Apple Silicon or Windows.
For developers:
- Clone the repository
$ https://github.com/alexpinel/Dot.git
- Install Node js and then run
npm install
inside the project repository, you can runnpm install --force
if you face any issues at this stage. Once complete, move tocd aadotllm
and runnpm install
once more!
🌟 Future Features I'd Like to Add
- Linux support
- Choice of LLM - Done!
- Image file support
- Enhanced document awareness beyond content
- Simplified file loading (select individual files, not just folders)
- Increased security measures for using local LLMs
- Support for additional document types - Done!
- Efficient file database management for quicker access to groups of files
🤝 Want to Help?
Contributions are highly encouraged! As a student managing this project on the side, any help is greatly appreciated. Whether it's coding, documentation, or feature suggestions, please feel free to get involved!
Star History
<div align="center"> <strong><a href="#top">Back to top</a></strong> </div>