Skip to content

Latest commit

 

History

History
131 lines (101 loc) · 5.59 KB

README.md

File metadata and controls

131 lines (101 loc) · 5.59 KB
Raw
logo

Maid - Mobile Artificial Intelligence Distribution

Build Android Build Linux Build MacOS Build Windows

Maid is a cross-platform free and an open-source application for interfacing with llama.cpp models locally, and remotely with Ollama, Mistral, Google Gemini and OpenAI models remotely. Maid supports sillytavern character cards to allow you to interact with all your favorite characters. Maid supports downloading a curated list of Models in-app directly from huggingface.

Cloning

Maid utilises git submodules extensively. To clone the repository, use the following command:

git clone --recursive https://github.com/Mobile-Artificial-Intelligence/maid.git

Maids repository has flutter linked as a submodule. This is needed for reproducible fdroid builds. However, for development you may want to use a local install of flutter. Remove the flutter submodule by running the git command

git submodule deinit -f packages/flutter

Installing Build Dependencies

To install the dependencies on fedora based systems, use the following command:

sudo dnf install -y cmake ninja-build pkg-config gtk3-devel vulkan-devel

To install the bdependencies on debian based systems, use the following command:

sudo apt-get install -y cmake ninja-build pkg-config libgtk-3-dev libvulkan-dev

Platform Support

Windows, MacOS, Linux, Android. Releases page. IOS Releases not available at this time.

Help Wanted

  • Write code comments
  • Documentation
  • Testing and Building on IOS
  • Spreading the word
  • Google Play Testing

Special Thanks and Related Projects

Star History

Star History Chart

Contributors

Testing

MacOS version tested on a Android version tested on a Oneplus 10 Pro 11gb phone. Also tested on Fedora Linux, Windows 11. Tested with calypso 3b, orcamini 3b, minyllama 1.1b, phi 3, mistral 7b, mixtral 8x7b, llama 2 7B-Chat, llama 7B and many more.

Disclaimer

Maid is distributed under the MIT licence and is provided without warranty of any kind, express or implied. Maid is not affiliated with Huggingface, Meta (Facebook), MistralAi, OpenAI, Google, Microsoft or any other company providing a model compatible with this application.

📜 License

This project is licensed under the MIT License.