mirror of https://github.com/invoke-ai/InvokeAI synced 2024-08-30 20:32:17 +00:00

Go to file

Lincoln Stein 4fd97ceddd remove redundant code line (#2068 ) * remove redundant code line install.bat was copying the requirements file into the install folder twice, causing an error message on the second try. This fixes the issue. * add further improvements to installer - Windows version will unzip to have requirements.txt already in the right location, to prevent problems when users try to run the .bat script from within a mounted read-only zip file manager. - Do not assume that "pip" is on the path in either the .bat or shell versions of the update script.		2022-12-19 14:57:41 +00:00
.dev_scripts	Replace --full_precision with --precision that works even if not specified	2022-09-20 17:08:00 -04:00
.github	set workflow PR triggers to filter PR-types (#2065 )	2022-12-18 20:54:07 +00:00
assets	merge release-candidate-1-3-2 into main.	2022-11-12 17:17:07 +00:00
backend	Fix GUI not working (#1916 )	2022-12-11 06:53:40 -05:00
binary_installer	Fix GUI not working (#1916 )	2022-12-11 06:53:40 -05:00
configs	Fix Inpainting Model entry in models.yaml.example	2022-12-10 23:52:24 -05:00
docker-build	update (docker-)build scripts, `.dockerignore` and add patchmatch (#1970 )	2022-12-16 13:53:37 +01:00
docs	(docs) update installer links as per some Discord reports	2022-12-18 22:32:33 -05:00
environments-and-requirements	delete old 'server' package and the dependency_injector requirement (#2032 )	2022-12-16 06:28:16 -05:00
frontend	Added compiled TS changes	2022-12-17 20:56:42 -05:00
installer	remove redundant code line (#2068 )	2022-12-19 14:57:41 +00:00
ldm	Don't crash CLI on exceptions (#2066 )	2022-12-18 16:28:47 +01:00
notebooks	Merge dev into main for 2.2.0 (#1642 )	2022-11-30 16:12:23 -05:00
scripts	Relax Huggingface login requirement during setup (#2046 )	2022-12-18 10:44:50 +01:00
static	Merge dev into main for 2.2.0 (#1642 )	2022-11-30 16:12:23 -05:00
tests	remove redundant tests, only do 20 steps (#1972 )	2022-12-13 19:39:29 +01:00
.dockerignore	update (docker-)build scripts, `.dockerignore` and add patchmatch (#1970 )	2022-12-16 13:53:37 +01:00
.editorconfig	Merge dev into main for 2.2.0 (#1642 )	2022-11-30 16:12:23 -05:00
.gitattributes	Update .gitattributes	2022-08-29 16:58:41 -05:00
.gitignore	Add invokeai.init to gitignore	2022-12-11 11:19:22 -05:00
.gitmodules	remove src directory, which is gumming up conda installs; addresses issue #77	2022-08-25 10:43:05 -04:00
.prettierrc.yaml	change printWidth for markdown files to 80	2022-09-17 02:23:00 +02:00
CODE_OF_CONDUCT.md	Merge dev into main for 2.2.0 (#1642 )	2022-11-30 16:12:23 -05:00
InvokeAI_Statement_of_Values.md	Merge dev into main for 2.2.0 (#1642 )	2022-11-30 16:12:23 -05:00
LICENSE	adding license using GitHub template	2022-10-17 12:09:24 -04:00
LICENSE-ModelWeights.txt	added assertion checks for out-of-bound arguments; added various copyright and license agreement files	2022-08-24 09:22:27 -04:00
main.py	Merge dev into main for 2.2.0 (#1642 )	2022-11-30 16:12:23 -05:00
mkdocs.yml	(docs) add redirects for moved pages (#2063 )	2022-12-18 08:04:58 +00:00
README.md	Replace latest link	2022-12-16 10:22:44 +13:00
setup.py	Relax Huggingface login requirement during setup (#2046 )	2022-12-18 10:44:50 +01:00
shell.nix	nix: add shell.nix file	2022-10-25 07:08:31 -04:00
Stable_Diffusion_v1_Model_Card.md	stable diffusion	2022-08-10 16:30:49 +02:00

README.md

InvokeAI: A Stable Diffusion Toolkit

This is a fork of CompVis/stable-diffusion, the open source text-to-image generator. It provides a streamlined process with various new features and options to aid the image generation process. It runs on Windows, macOS and Linux machines, with GPU cards with as little as 4 GB of RAM. It provides both a polished Web interface (see below), and an easy-to-use command-line interface.

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 the Issues tab to report bugs and make feature requests. Be sure to use the provided templates. They will help us diagnose issues faster.

Getting Started with InvokeAI

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

Go to the bottom of the Latest Release Page
Download the .zip file for your OS (Windows/macOS/Linux).
Unzip the file.
If you are on Windows, double-click on the install.bat script. On macOS, open a Terminal window, drag the file install.sh from Finder into the Terminal, and press return. On Linux, run install.sh.
Wait a while, until it is done.
The folder where you ran the installer from will now be filled with lots of files. If you are on Windows, double-click on the invoke.bat file. On macOS, open a Terminal window, drag invoke.sh from the folder into the Terminal, and press return. On Linux, run invoke.sh
Press 2 to open the "browser-based UI", press enter/return, wait a minute or two for Stable Diffusion to start up, then open your browser and go to http://localhost:9090.
Type banana sushi in the box on the top left and click Invoke:

Installation
Hardware Requirements
Features
Latest Changes
Troubleshooting
Contributing
Contributors
Support
Further Reading

Installation

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

Hardware Requirements

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

System

You wil need one of the following:

An NVIDIA-based graphics card with 4 GB or more VRAM memory.
An Apple computer with an M1 chip.

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

Memory

At least 12 GB Main Memory RAM.

Disk

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

Note

If you have a Nvidia 10xx series card (e.g. the 1080ti), please run the dream script in full-precision mode as shown below.

Similarly, specify full-precision mode on Apple M1 hardware.

Precision is auto configured based on the device. If however you encounter errors like 'expected type Float but found Half' or 'not implemented for Half' you can try starting invoke.py with the --precision=float32 flag to your initialization command

(invokeai) ~/InvokeAI$ python scripts/invoke.py --precision=float32

Or by updating your InvokeAI configuration file with this argument.

Features

Major Features

Other Features

Latest Changes

For our latest changes, view our Release Notes

Troubleshooting

Please check out our Q&A to get solutions for common installation problems and other issues.

Contributing

Anyone who wishes to contribute to this project, whether documentation, features, bug fixes, code cleanup, 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 are unfamiliar with how to contribute to GitHub projects, here is a Getting Started Guide. A full set of contribution guidelines, along with templates, are in progress. You can make 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 elect to become part of our community.

Welcome to InvokeAI!

Contributors

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 for their time, hard work and effort.

Support

For support, please use this repository's GitHub Issues tracking service. Feel free to send me an email if you use and like the script.