Home

Awesome

Banner Discord PyPi GitHub GitHub last commit GitHub issues GitHub closed issues GitHub pull requests GitHub closed pull requests


AI Runner

AI Runner is an interface which allows you to run open-source large language models (LLM) and AI image generators (Stable Diffusion) on your own hardware.

It is designed to be easy to use, with a simple and intuitive interface that allows you to run AI models without the need for a web server or cloud service.

It has been optimized for speed and efficiency, allowing you to generate images and have conversations with chatbots in real-time.

Stable Diffusion

img.png

Customizable Chatbots with Moods and Personalities

img_1.png


ā­ Features

AI Runner is an AI interface which allows you to run open-source large language models (LLM) and AI image generators (Stable Diffusion) on your own hardware.

FeatureDescription
šŸ—£ļø LLMs and communication
Voice-based chatbot conversationsHave conversations with a chatbot using your voice
Text-to-speechConvert text to spoken audio
Speech-to-textConvert spoken audio to text
Customizable chatbots with LLMsGenerate text using large language models
RAG on local documents and websitesInteract with your local documents using an LLM
šŸŽØ Image Generation
Stable Diffusion (all versions)Generate images using Stable Diffusion
Drawing toolsTurn sketches into art
Text-to-ImageGenerate images from textual descriptions
Image-to-ImageGenerate images based on input images
šŸ–¼ļø Image Manipulation
Inpaint and OutpaintModify parts of an image while maintaining context
ControlnetControl image generation with additional input
LoRAEfficiently fine-tune models with LoRA
Textual EmbeddingsUse textual embeddings for image generation control
Image FiltersBlur, film grain, pixel art and more
šŸ”§ Utility
Run offline, locallyRun on your own hardware without internet
Fast generationGenerate images in ~2 seconds (RTX 2080s)
Run multiple models at onceUtilize multiple models simultaneously
Dark modeComfortable viewing experience in low-light environments
Infinite scrolling canvasSeamlessly scroll through generated images
NSFW filter toggleHelp control the visibility of NSFW content
NSFW guardrails toggleHelp prevent generation of LLM harmful content
Fully customizableEasily adjust all parameters
Fast load time, responsive interfaceEnjoy a smooth and responsive user experience
Pure pythonNo reliance on a webserver, pure python implementation

šŸ’» System Requirements

Minimum system requirements

Recommended system specs


šŸš€ Installation

There are several ways to get started with AI Runner such as packaged, from source and as a library.

Detailed packaging and installation instructions can be found in the wiki.

Install as a library

Installation

pip install airunner

Running

airunner

Models

AI Runner installs all of the models required to run a chatbot with text-to-speech and speech-to-text capabilities, as well as the core models required for Stable Diffusion. However, you must supply your own art generator models.

You can download models from Huggingface.co or civitai.com.

The supported Stable Diffusion models are:

Models must be placed in their respective directories in the airunner directory.

~/.local/share/airunner
ā”œā”€ā”€ art
ā”‚   ā”œā”€ā”€ models
ā”‚   ā”‚   ā”œā”€ā”€ SD 1.5
ā”‚   ā”‚   ā”‚   ā”œā”€ā”€ lora
ā”‚   ā”‚   ā”‚   ā””ā”€ā”€ embeddings
ā”‚   ā”‚   ā”œā”€ā”€ SDXL 1.0
ā”‚   ā”‚   ā”‚   ā”œā”€ā”€ lora
ā”‚   ā”‚   ā”‚   ā””ā”€ā”€ embeddings
ā”‚   ā”‚   ā””ā”€ā”€ SDXL Turbo
ā”‚   ā”‚       ā”œā”€ā”€ lora
ā”‚   ā”‚       ā””ā”€ā”€ embeddings

Unit tests

Run all unit tests

python -m unittest discover -s src/airunner/tests

Run a single unit tests python -m unittest src/airunner/tests/<file_name>

Example

python -m unittest src/airunner/tests/test_prompt_weight_convert.py

Privacy and Security

Although AI Runner v3.0 is built with Huggingface libraries, we have taken care to strip the application of any telemetry or tracking features.


Internet access

Only the setup wizard needs access to the internet in order to download the required models.

For more information see the Darklock and Facehuggershield libraries.


Disc access

Write access for the transformers library has been disabled, preventing it from creating a huggingface cache directory at runtime.

The application itself may still access the disc for reading and writing, however we have restricted reads and writes to the user provided airunner directory (by default this is located at ~/.local/share/airunner).

All other attempts to access the disc are blocked and logged for your review.

For more information see src/security/restrict_os_access.py.


Huggingface Hub

Huggingface Hub contains telemetry and tracking features that have been completely disabled in AI Runner.

The security measures taken for this library are as follows

See Facehuggershield for more information.