Repository files navigation

Note: The UI is not fully functional onmain. If you need a stable UI based onmain, use thepre-nodes tag while wemigrate to a new backend.

InvokeAI is a leading creative engine built to empower professionals and enthusiasts alike. Generate and create stunning visual media using the latest AI-driven technologies. InvokeAI offers an industry leading Web Interface, interactive Command Line Interface, and also serves as the foundation for multiple commercial products.

Quick links: [How to Install] [Discord Server] [Documentation and Tutorials] [Code and Downloads] [Bug Reports] [Discussion, Ideas & Q&A]

Note: InvokeAI is rapidly evolving. Please use theIssues tab to report bugs and make featurerequests. Be sure to use the provided templates. They will help us diagnose issues faster.

1. Quick Start
2. Installation
3. Hardware Requirements
4. Features
5. Latest Changes
6. Troubleshooting
7. Contributing
8. Contributors
9. Support
10. Further Reading

For full installation and upgrade instructions, please see:InvokeAI Installation Overview

1. Go to the bottom of theLatest Release Page

2. Download the .zip file for your OS (Windows/macOS/Linux).

3. Unzip the file.

4. If you are on Windows, double-click on theinstall.bat script. OnmacOS, open a Terminal window, drag the fileinstall.sh from Finderinto the Terminal, and press return. On Linux, runinstall.sh.

5. You'll be asked to confirm the location of the folder in whichto install InvokeAI and its image generation model files. Pick alocation with at least 15 GB of free memory. More if you plan oninstalling lots of models.

6. Wait while the installer does its thing. After installing the software,the installer will launch a script that lets you configure InvokeAI andselect a set of starting image generation models.

7. Find the folder that InvokeAI was installed into (it is not thesame as the unpacked zip file directory!) The default location of thisfolder (if you didn't change it in step 5) is~/invokeai onLinux/Mac systems, andC:\Users\YourName\invokeai on Windows. This directory will contain launcher scripts namedinvoke.sh andinvoke.bat.

8. On Windows systems, double-click on theinvoke.bat file. OnmacOS, open a Terminal window, draginvoke.sh from the folder intothe Terminal, and press return. On Linux, runinvoke.sh

9. Press 2 to open the "browser-based UI", press enter/return, wait aminute or two for Stable Diffusion to start up, then open your browserand go tohttp://localhost:9090.

10. Typebanana sushi in the box on the top left and clickInvoke

You must have Python 3.9 or 3.10 installed on your machine. Earlier or later versions arenot supported.

1. Open a command-line window on your machine. The PowerShell is recommended for Windows.

2. Create a directory to install InvokeAI into. You'll need at least 15 GB of free space:

   mkdir invokeai

3. Create a virtual environment named.venv inside this directory and activate it:

   cd invokeaipython -m venv .venv --prompt InvokeAI

4. Activate the virtual environment (do it every time you run InvokeAI)

   For Linux/Mac users:

   source .venv/bin/activate

   For Windows users:

   .venv\Scripts\activate

5. Install the InvokeAI module and its dependencies. Choose the command suited for your platform & GPU.

   For Windows/Linux with an NVIDIA GPU:

   pip install "InvokeAI[xformers]" --use-pep517 --extra-index-url https://download.pytorch.org/whl/cu117

   For Linux with an AMD GPU:

   pip install InvokeAI --use-pep517 --extra-index-url https://download.pytorch.org/whl/rocm5.4.2

   For non-GPU systems:

   pip install InvokeAI --use-pep517 --extra-index-url https://download.pytorch.org/whl/cpu

   For Macintoshes, either Intel or M1/M2:

   pip install InvokeAI --use-pep517

6. Configure InvokeAI and install a starting set of image generation models (you only need to do this once):

   invokeai-configure

7. Launch the web server (do it every time you run InvokeAI):

   invokeai --web

8. Point your browser tohttp://localhost:9090 to bring up the web interface.

9. Typebanana sushi in the box on the top left and clickInvoke.

Be sure to activate the virtual environment each time before re-launching InvokeAI,usingsource .venv/bin/activate or.venv\Scripts\activate.

This fork is supported across Linux, Windows and Macintosh. Linuxusers can use either an Nvidia-based card (with CUDA support) or anAMD card (using the ROCm driver). For full installation and upgradeinstructions, please see:InvokeAI Installation Overview

InvokeAI is supported across Linux, Windows and macOS. Linuxusers can use either an Nvidia-based card (with CUDA support) or anAMD card (using the ROCm driver).

You will need one of the following:

• An NVIDIA-based graphics card with 4 GB or more VRAM memory.
• An Apple computer with an M1 chip.
• An AMD-based graphics card with 4GB or more VRAM memory. (Linux only)

We do not recommend the GTX 1650 or 1660 series video cards. They areunable to run in half-precision mode and do not have sufficient VRAMto render 512x512 images.

• At least 12 GB Main Memory RAM.

• At least 12 GB of free disk space for the machine learning model, Python, and all its dependencies.

Feature documentation can be reviewed by navigating tothe InvokeAI Documentation page

InvokeAI offers a locally hosted Web Server & React Frontend, with an industry leading user experience. The Web-based UI allows for simple and intuitive workflows, and is responsive for use on mobile devices and tablets accessing the web server.

The Unified Canvas is a fully integrated canvas implementation with support for all core generation capabilities, in/outpainting, brush tools, and more. This creative tool unlocks the capability for artists to create with AI as a creative collaborator, and can be used to augment AI-generated imagery, sketches, photography, renders, and more.

InvokeAI's advanced prompt syntax allows for token weighting, cross-attention control, and prompt blending, allowing for fine-tuned tweaking of your invocations and exploration of the latent space.

For users utilizing a terminal-based environment, or who want to take advantage of CLI features, InvokeAI offers an extensive and actively supported command-line interface that provides the full suite of generation functionality available in the tool.

• Support for both ckpt and diffusers models
• SD 2.0, 2.1 support
• Noise Control & Tresholding
• Popular Sampler Support
• Upscaling & Face Restoration Tools
• Embedding Manager & Support
• Model Manager & Support

• Node-Based Architecture & UI
• And more...

For our latest changes, view ourReleaseNotes and theCHANGELOG.

Please check out ourQ&A to get solutions for common installationproblems and other issues.

Anyone who wishes to contribute to this project, whether documentation, features, bug fixes, codecleanup, testing, or code reviews, is very much encouraged to do so.

To join, just raise your hand on the InvokeAI Discord server (#dev-chat) or the GitHub discussion board.

If you'd like to help with translation, please see ourtranslation guide.

If you are unfamiliar with howto contribute to GitHub projects, here is aGetting Started Guide. A full set of contribution guidelines, along with templates, are in progress. You canmake your pull request against the "main" branch.

We hope you enjoy using our software as much as we enjoy creating it,and we hope that some of those of you who are reading this will electto become part of our community.

Welcome to InvokeAI!

This fork is a combined effort of various people from across the world.Check out the list of all these amazing people. We thank them fortheir time, hard work and effort.

Thanks toWeblate for generously providing translation services to this project.

For support, please use this repository's GitHub Issues tracking service, or join the Discord.

Original portions of the software are Copyright (c) 2023 by respective contributors.