InvokeAI/docs/installation/INSTALL_INVOKE.md
2022-12-02 06:20:16 -05:00

2.6 KiB

title
InvokeAI Binary Installer

The InvokeAI binary installer is a shell script that will install InvokeAI onto a stock computer running recent versions of Linux, MacOSX or Windows. It will leave you with a version that runs a stable version of InvokeAI. When a new version of InvokeAI is released, you will download and reinstall the new version.

If you wish to tinker with unreleased versions of InvokeAI that introduce potentially unstable new features, you should consider using the source installer or one of the manual install methods.

Important Caveats

  • This script does not support AMD GPUs. For Linux AMD support, please use the manual or source code installer methods.

  • This script has difficulty on some Macintosh machines that have previously been used for Python development due to conflicting development tools versions. Mac developers may wish to try the source code installer or one of the manual methods instead.

!!! todo

Before you begin, make sure that you meet
the[hardware requirements](/#hardware-requirements) and has the
appropriate GPU drivers installed. In particular, if you are a Linux user with
an AMD GPU installed, you may need to install the
[ROCm-driver](https://rocmdocs.amd.com/en/latest/Installation_Guide/Installation-Guide.html).

Installation requires roughly 18G of free disk space to load the libraries and recommended model weights files.

Steps to Install

  1. Download the latest release of InvokeAI's installer for your platform. Look for a file named InvokeAI-binary-<your platform>.zip

  2. Place the downloaded package someplace where you have plenty of HDD space, and have full permissions (i.e. ~/ on Lin/Mac; your home folder on Windows)

  3. Extract the 'InvokeAI' folder from the downloaded package

  4. Open the extracted 'InvokeAI' folder

  5. Double-click 'install.bat' (Windows), or 'install.sh' (Lin/Mac) (or run from a terminal)

  6. Follow the prompts

  7. After installation, please run the 'invoke.bat' file (on Windows) or 'invoke.sh' file (on Linux/Mac) to start InvokeAI.

Troubleshooting

If you run into problems during or after installation, the InvokeAI team is available to help you. Either create an Issue at our GitHub site, or make a request for help on the "bugs-and-support" channel of our Discord server. We are a 100% volunteer organization, but typically somebody will be available to help you within 24 hours, and often much sooner.