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
bf399e303c
InvokeAI/docs/installation/index.md
Lincoln Stein 1b743f7d9b source installer improvements and documentation 
- Source installer provides more context for what it is doing, and
  sends user to help/troubleshooting pages when something goes wrong.

- install.sh and install.bat are renamed to install.sh.in and install.bat.in
  to discourage users from running them from within the

- Documentation updated
2022-12-01 19:40:13 +00:00

3.2 KiB
Raw Blame History

title
Overview

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

  1. InvokeAI binary installer

    This is a installer script that installs InvokeAI and all the third party libraries it depends on. It includes access to a "developer console" which will help us debug problems with you and give you to access experimental features.

    When a new InvokeAI release is available, you will run an update script to download and install the new version. Intermediate versions that contain experimental and possibly unstable features will not be available.

    This installer is designed for people who want the system to "just work", don't have an interest in tinkering with it, and do not care about upgrading to unreleased experimental features.

    Important Caveats

    • This script does not support AMD GPUs. For Linux AMD support, please use the manual or source code installer methods.
    • The tab autocomplete feature of the command-line client, which completes commonly used filenames and commands, will not work in this version. All Web UI functions are fully operational, however.

  2. InvokeAI source code installer

    This is a script that will install Python, the Anaconda ("conda") package manager, all of InvokeAI's its essential third party libraries and InvokeAI itself. It includes access to a "developer console" which will help us debug problems with you and give you to access experimental features.

    When a new InvokeAI feature is available, even between releases, you will be able to upgrade and try it out by running an update script. This method is recommended for individuals who wish to stay on the cutting edge of InvokeAI development and are not afraid of occasional breakage.

    Important Caveats

    • This script is a bit cranky and occasionally hangs or times out, forcing you to cancel and restart the script (it will pick up where it left off). It also takes noticeably longer to run than the binary installer.

  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.