Skip to content

Linux#

Installation#

  1. You will need to install the following prerequisites if they are not already available. Use your operating system's preferred installer.

    • Python (version 3.8.5 recommended; higher may work)
    • git

  2. Install the Python Anaconda environment manager.

    ~$  wget https://repo.anaconda.com/archive/Anaconda3-2022.05-Linux-x86_64.sh
~$  chmod +x Anaconda3-2022.05-Linux-x86_64.sh
~$  ./Anaconda3-2022.05-Linux-x86_64.sh

    After installing anaconda, you should log out of your system and log back in. If the installation worked, your command prompt will be prefixed by the name of the current anaconda environment - (base).

  3. Copy the InvokeAI source code from GitHub:

    (base) ~$ git clone https://github.com/invoke-ai/InvokeAI.git

    This will create InvokeAI folder where you will follow the rest of the steps.

  4. Enter the newly-created InvokeAI folder. From this step forward make sure that you are working in the InvokeAI directory!

    (base) ~$ cd InvokeAI
(base) ~/InvokeAI$

  5. Use anaconda to copy necessary python packages, create a new python environment named invokeai and then activate the environment.

    For systems with a CUDA (Nvidia) card:

    (base) rm -rf src      # (this is a precaution in case there is already a src directory)
(base) ~/InvokeAI$ conda env create -f environment-cuda.yml
(base) ~/InvokeAI$ conda activate invokeai
(invokeai) ~/InvokeAI$

    For systems with an AMD card (using ROCm driver):

    (base) rm -rf src      # (this is a precaution in case there is already a src directory)
(base) ~/InvokeAI$ conda env create -f environment-AMD.yml
(base) ~/InvokeAI$ conda activate invokeai
(invokeai) ~/InvokeAI$

    After these steps, your command prompt will be prefixed by (invokeai) as shown above.

  6. Load the big stable diffusion weights files and a couple of smaller machine-learning models:

    (invokeai) ~/InvokeAI$ python3 scripts/configure_invokeai.py

    Note

    This script will lead you through the process of creating an account on Hugging Face, accepting the terms and conditions of the Stable Diffusion model license, and obtaining an access token for downloading. It will then download and install the weights files for you.

    Please look here for a manual process for doing the same thing.

  7. Start generating images!

    Run InvokeAI!

    IMPORTANT

    Make sure that the conda environment is activated, which should create (invokeai) in front of your prompt!

    python scripts/invoke.py

    python scripts/invoke.py --web

    python scripts/invoke.py --web --host 0.0.0.0

    To use an alternative model you may invoke the !switch command in the CLI, or pass --model <model_name> during invoke.py launch for either the CLI or the Web UI. See Command Line Client. The model names are defined in configs/models.yaml.

  8. Subsequently, to relaunch the script, be sure to run "conda activate invokeai" (step 5, second command), enter the InvokeAI directory, and then launch the invoke script (step 8). If you forget to activate the 'invokeai' environment, the script will fail with multiple ModuleNotFound errors.

Updating to newer versions of the script#

This distribution is changing rapidly. If you used the git clone method (step 5) to download the InvokeAI directory, then to update to the latest and greatest version, launch the Anaconda window, enter InvokeAI and type:

(invokeai) ~/InvokeAI$ git pull
(invokeai) ~/InvokeAI$ rm -rf src   # prevents conda freezing errors
(invokeai) ~/InvokeAI$ conda env update -f environment.yml

This will bring your local copy into sync with the remote one.

Last update: December 15, 2022
Created: September 11, 2022