Mirrored_Repos/InvokeAI
1
0
Fork 0
mirror of https://github.com/invoke-ai/InvokeAI synced 2024-08-30 20:32:17 +00:00
Code Issues Packages Projects Releases Wiki Activity
40a48aca88
InvokeAI/docs/installation/INSTALL.md
Lincoln Stein b850dbadaf finished reorganization of install docs
2022-11-09 20:16:57 +00:00

2.4 KiB
Raw Blame History

title
Installation Overview

Installation

We offer several ways to install InvokeAI, each one suited to your experience and preferences.

  1. 1-click installer

    This is an automated shell script that will handle installation of all dependencies for you, and is recommended for those who have limited or no experience with the Python programming language, are not currently interested in contributing to the project, and just want the thing to install and run. In this version, you interact with the web server and command-line clients through a shell script named invoke.sh (Linux/Mac) or invoke.bat (Windows), and perform updates using update.sh and update.bat.

  2. Pre-compiled PIP installer

    This is a series of installer files for which all the requirements for InvokeAI have been precompiled, thereby preventing the conflicts that sometimes occur when an external library is changed unexpectedly. It will leave you with an environment in which you interact directly with the scripts for running the web and command line clients, and you will update to new versions using standard developer commands.

    This method is recommended for users with a bit of experience using the git and pip tools.

  3. Manual Installation

    In this method you will manually run the commands needed to install InvokeAI and its dependencies. We offer two recipes: one suited to those who prefer the conda tool, and one suited to those who prefer pip and Python virtual environments.

    This method is recommended for users who have previously used conda or pip in the past, developers, and anyone who wishes to remain on the cutting edge of future InvokeAI development and is willing to put up with occasional glitches and breakage.

  4. Docker Installation

    We also offer a method for creating Docker containers containing InvokeAI and its dependencies. This method is recommended for individuals with experience with Docker containers and understand the pluses and minuses of a container-based install.

  5. Jupyter Notebooks Installation

    This method is suitable for running InvokeAI on a Google Colab account. It is recommended for individuals who have previously worked on the Colab and are comfortable with the Jupyter notebook environment.