Alpaca Electron
Alpaca Electron is built from the ground-up to be the easiest way to chat with the alpaca AI models. No command line or compiling needed!
📃 Features + to-do
- Runs locally on your computer, internet connection is not needed except when downloading models
- Compact and efficient since it uses alpaca.cpp as it's backend
- Runs on CPU, anyone can run it without an expensive graphics card
- No external dependencies required, everything is included in the installer
- "Borrowed" UI from that popular chat AI
- Supports Windows and MacOS
- Docker-ized 🐋
- Linux support
- Chat history
- Context memory
- Integration with Stable Diffusion
🎞 Demo
🚀 Quick Start Guide
- Download an Alpaca model (7B native is recommended) and place it somewhere on your computer where it's easy to find.
Note
Download links will not be provided in this repository.
-
Download the latest installer from the releases page section.
-
Open the installer and wait for it to install.
-
Once done installing, it'll ask for a valid path to a model. Now, go to where you placed the model, hold shift, right click on the file, and then click on "Copy as Path". Then, paste this into that dialog box and click
Confirm
. -
The program will automatically restart. Now you can begin chatting!
Note
The program will also accept any other 4 bit quantized .bin model files. If you can find other .bin Alpaca model files, you can use them instead of the one recommended in the Quick Start Guide to experiment with different models. As always, be careful about what you download from the internet.
🔧 Troubleshooting
General
- If you get an error that says "Invalid file path" when pasting the path to the model file, you probably have some sort of misspelling in there. Try copying the path again or using the file picker.
- If you get an error that says "Couldn't load model", your model is probably corrupted or incompatible. Try downloading the model again.
- If you face other problems or issues not listed here, create an issue in the "Issues" tab at the top of this page. Describe in detail what happens, and include screenshots.
Windows
- If the model has been loaded into RAM but text generation doesn't seem start, check to see if your CPU is compatible with the AVX2 instruction set. If it does not support AVX2, Alpaca Electron will use AVX instead, which is much slower so be patient.
MacOS
- If you get an error that says "App can't be opened because it is from an unidentified developer.", go to the Applications folder. Then, hold the control key and click on the app. Then click "Open", then click "Open" when it gives you a warning. Your preference will be saved and MacOS will let you open the app normally from now on.
Linux
-
You can either download the prebuilt binary (packaged as tar.gz), extract it and execute it with
./alpaca-electron
or build the application on yourself. -
If you want to build the application yourself:
Clone the repository:
git clone https://github.com/ItsPi3141/alpaca-electron.git
Change your current directory to alpaca-electron:
cd alpaca-electron
Install application specific dependencies:
npm install --save-dev
Build the application:
npm run linux-x64
Change your current directory to the build target:
cd release-builds/alpaca-electron-linux-x64
Run the application with
./alpaca-electron
Docker Compose
- You can run this electron application with docker compose. Therefore you need to compelete the following steps:
Clone the repository:
git clone https://github.com/ItsPi3141/alpaca-electron.git
Change your current directory to alpaca-electron:
cd alpaca-electron
Build the container image:
docker compose build
Run the application container:
docker compose up -d
- If no window opens up run
docker compose up
(without the -d). If there is an error likeAuthorization required, but no authorization protocol specified
runxhost local:root
on your docker host.
👨💻 Credits
Credits go to @antimatter15 for creating alpaca.cpp and to @ggerganov for creating llama.cpp, the backbones behind alpaca.cpp. Finally, credits go to Meta and Stanford for creating the LLaMA and Alpaca models, respectively.
Special thanks to @keldenl for providing arm64 builds for MacOS