Documentation • Patch Notes • Get Started
BunnyBot is an AI assistant chatbot application that enables speech-to-speech and text-based conversation with a locally hosted LLM. This project serves as a personal study on Python, LLMs, and the practical application of NLP.
- Speech & Text Chat: Interact with the AI using either your voice or a text chatbox.
- Locally Hosted LLM: Utilizes LM Studio for a private and customizable experience.
- Browser-Based UI: Powered by Flask for an intuitive and user-friendly interface.
- Persistent Conversation Logs: Automatic chat history logging and saving.
📚 Read the full list of features on our Wiki!
Follow these steps to get BunnyBot up and running.
- Install Prerequisites:
- Install Python 3.10+, LM Studio, and Docker.
- Set up a local server in LM Studio and load an LLM of your choice.
- Run the Docker quick start setup for TTS functionality.
- Clone the Repository:
git clone https://github.com/LumiBunny/BnuuyBotApp.git
- Install Python Dependencies:
pip install -r requirements.txt
- Run the Application:
python main.py
As this is an app in early development, I have not used or tested it on any other hardware. Here is my current PC configuration:
📝 See my full PC configuration, including drivers and software, on the Wiki for more details.)
Version 0.5.7: Made some major changes to the code and structure following some recent updates to LM Studio. These changes primarily use a more streamlined completions method for chatting, as well as a new and improved ChatHistory class, more reliable PreferenceExtractor, updated MemoryManager, and more.