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

Go to file

Lincoln Stein 4536e4a8b6 Model Manager Refactor: Install remote models and store their tags and other metadata (#5361 ) * add basic functionality for model metadata fetching from hf and civitai * add storage * start unit tests * add unit tests and documentation * add missing dependency for pytests * remove redundant fetch; add modified/published dates; updated docs * add code to select diffusers files based on the variant type * implement Civitai installs * make huggingface parallel downloading work * add unit tests for model installation manager - Fixed race condition on selection of download destination path - Add fixtures common to several model_manager_2 unit tests - Added dummy model files for testing diffusers and safetensors downloading/probing - Refactored code for selecting proper variant from list of huggingface repo files - Regrouped ordering of methods in model_install_default.py * improve Civitai model downloading - Provide a better error message when Civitai requires an access token (doesn't give a 403 forbidden, but redirects to the HTML of an authorization page -- arrgh) - Handle case of Civitai providing a primary download link plus additional links for VAEs, config files, etc * add routes for retrieving metadata and tags * code tidying and documentation * fix ruff errors * add file needed to maintain test root diretory in repo for unit tests * fix self->cls in classmethod * add pydantic plugin for mypy * use TestSession instead of requests.Session to prevent any internet activity improve logging fix error message formatting fix logging again fix forward vs reverse slash issue in Windows install tests * Several fixes of problems detected during PR review: - Implement cancel_model_install_job and get_model_install_job routes to allow for better control of model download and install. - Fix thread deadlock that occurred after cancelling an install. - Remove unneeded pytest_plugins section from tests/conftest.py - Remove unused _in_terminal_state() from model_install_default. - Remove outdated documentation from several spots. - Add workaround for Civitai API results which don't return correct URL for the default model. * fix docs and tests to match get_job_by_source() rather than get_job() * Update invokeai/backend/model_manager/metadata/fetch/huggingface.py Co-authored-by: Ryan Dick <ryanjdick3@gmail.com> * Call CivitaiMetadata.model_validate_json() directly Co-authored-by: Ryan Dick <ryanjdick3@gmail.com> * Second round of revisions suggested by @ryanjdick: - Fix type mismatch in `list_all_metadata()` route. - Do not have a default value for the model install job id - Remove static class variable declarations from non Pydantic classes - Change `id` field to `model_id` for the sqlite3 `model_tags` table. - Changed AFTER DELETE triggers to ON DELETE CASCADE for the metadata and tags tables. - Made the `id` field of the `model_metadata` table into a primary key to achieve uniqueness. * Code cleanup suggested in PR review: - Narrowed the declaration of the `parts` attribute of the download progress event - Removed auto-conversion of str to Url in Url-containing sources - Fixed handling of `InvalidModelConfigException` - Made unknown sources raise `NotImplementedError` rather than `Exception` - Improved status reporting on cached HuggingFace access tokens * Multiple fixes: - `job.total_size` returns a valid size for locally installed models - new route `list_models` returns a paged summary of model, name, description, tags and other essential info - fix a few type errors * consolidated all invokeai root pytest fixtures into a single location * Update invokeai/backend/model_manager/metadata/metadata_store.py Co-authored-by: psychedelicious <4822129+psychedelicious@users.noreply.github.com> * Small tweaks in response to review comments: - Remove flake8 configuration from pyproject.toml - Use `id` rather than `modelId` for huggingface `ModelInfo` object - Use `last_modified` rather than `LastModified` for huggingface `ModelInfo` object - Add `sha256` field to file metadata downloaded from huggingface - Add `Invoker` argument to the model installer `start()` and `stop()` routines (but made it optional in order to facilitate use of the service outside the API) - Removed redundant `PRAGMA foreign_keys` from metadata store initialization code. * Additional tweaks and minor bug fixes - Fix calculation of aggregate diffusers model size to only count the size of files, not files + directories (which gives different unit test results on different filesystems). - Refactor _get_metadata() and _get_download_urls() to have distinct code paths for Civitai, HuggingFace and URL sources. - Forward the `inplace` flag from the source to the job and added unit test for this. - Attach cached model metadata to the job rather than to the model install service. * fix unit test that was breaking on windows due to CR/LF changing size of test json files * fix ruff formatting * a few last minor fixes before merging: - Turn job `error` and `error_type` into properties derived from the exception. - Add TODO comment about the reason for handling temporary directory destruction manually rather than using tempfile.tmpdir(). * add unit tests for reporting HTTP download errors --------- Co-authored-by: Lincoln Stein <lstein@gmail.com> Co-authored-by: Ryan Dick <ryanjdick3@gmail.com> Co-authored-by: psychedelicious <4822129+psychedelicious@users.noreply.github.com>		2024-01-14 19:54:53 +00:00
.dev_scripts	Apply black	2023-07-27 10:54:01 -04:00
.github	Report ci disk space + minor docker fixes (#5461 )	2024-01-10 05:20:26 +00:00
coverage	combine pytest.ini with pyproject.toml	2023-03-05 17:00:08 +00:00
docker	Report ci disk space + minor docker fixes (#5461 )	2024-01-10 05:20:26 +00:00
docs	Model Manager Refactor: Install remote models and store their tags and other metadata (#5361 )	2024-01-14 19:54:53 +00:00
installer	feat: pin deps	2024-01-10 00:03:29 -05:00
invokeai	Model Manager Refactor: Install remote models and store their tags and other metadata (#5361 )	2024-01-14 19:54:53 +00:00
scripts	fix import unsorted import block issues in the tests	2023-11-26 13:37:47 -05:00
tests	Model Manager Refactor: Install remote models and store their tags and other metadata (#5361 )	2024-01-14 19:54:53 +00:00
.dockerignore	Update dockerignore, set venv to 3.10, pass cache to yarn vite buidl	2023-07-12 16:51:15 -04:00
.editorconfig	Merge dev into main for 2.2.0 (#1642 )	2022-11-30 16:12:23 -05:00
.git-blame-ignore-revs	(meta) hide the 'black' formatting commit from git blame	2023-07-27 11:29:22 -04:00
.gitattributes	Enforce Unix line endings in container (#4990 )	2023-10-30 12:34:30 -04:00
.gitignore	feat: no frontend build in repo	2023-12-11 12:30:13 +11:00
.gitmodules	remove src directory, which is gumming up conda installs; addresses issue #77	2022-08-25 10:43:05 -04:00
.pre-commit-config.yaml	Adding isort GHA and pre-commit hooks	2023-09-12 13:01:58 -04:00
.prettierrc.yaml	change printWidth for markdown files to 80	2022-09-17 02:23:00 +02:00
flake.lock	Add Nix Flake for development, which uses Python virtualenv.	2023-07-31 19:14:30 +10:00
flake.nix	fix: flake: add opencv with CUDA, new patchmatch dependency.	2023-08-01 23:56:41 +10:00
InvokeAI_Statement_of_Values.md	Add @ebr to Contributors (#2095 )	2022-12-21 14:33:08 -05:00
LICENSE	Update LICENSE	2023-07-05 23:46:27 -04:00
LICENSE-SD1+SD2.txt	updated LICENSE files and added information about watermarking	2023-07-26 17:27:33 -04:00
LICENSE-SDXL.txt	updated LICENSE files and added information about watermarking	2023-07-26 17:27:33 -04:00
Makefile	add the tag_release.sh script	2023-12-11 21:11:37 -05:00
mkdocs.yml	3.6 Docs updates (#5412 )	2024-01-11 16:52:22 +00:00
pyproject.toml	Model Manager Refactor: Install remote models and store their tags and other metadata (#5361 )	2024-01-14 19:54:53 +00:00
README.md	Update README.md	2024-01-04 15:56:44 -05:00
Stable_Diffusion_v1_Model_Card.md	Global replace [ \t]+$, add "GB" (#1751 )	2022-12-19 16:36:39 +00:00

README.md

Invoke - Professional Creative AI Tools for Visual Media

To learn more about Invoke, or implement our Business solutions, visit invoke.com

InvokeAI is a leading creative engine built to empower professionals and enthusiasts alike. Generate and create stunning visual media using the latest AI-driven technologies. InvokeAI offers an industry leading Web Interface, interactive Command Line Interface, and also serves as the foundation for multiple commercial products.

Quick links: [How to Install] [Discord Server] [Documentation and Tutorials] [Bug Reports] [Discussion, Ideas & Q&A] [Contributing]

Table of Contents 📝

Getting Started

🏁 Quick Start
🖥️ Hardware Requirements

More About Invoke

🌟 Features
📣 Latest Changes
🛠️ Troubleshooting

Supporting the Project

🤝 Contributing
👥 Contributors
💕 Support

Quick Start

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

If upgrading from version 2.3, please read Migrating a 2.3 root directory to 3.0 first.

Automatic Installer (suggested for 1st time users)

Go to the bottom of the Latest Release Page
Download the .zip file for your OS (Windows/macOS/Linux).
Unzip the file.
Windows: double-click on the install.bat script. macOS: Open a Terminal window, drag the file install.sh from Finder into the Terminal, and press return. Linux: run install.sh.
You'll be asked to confirm the location of the folder in which to install InvokeAI and its image generation model files. Pick a location with at least 15 GB of free memory. More if you plan on installing lots of models.
Wait while the installer does its thing. After installing the software, the installer will launch a script that lets you configure InvokeAI and select a set of starting image generation models.
Find the folder that InvokeAI was installed into (it is not the same as the unpacked zip file directory!) The default location of this folder (if you didn't change it in step 5) is ~/invokeai on Linux/Mac systems, and C:\Users\YourName\invokeai on Windows. This directory will contain launcher scripts named invoke.sh and invoke.bat.
On Windows systems, 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

Command-Line Installation (for developers and users familiar with Terminals)

You must have Python 3.10 through 3.11 installed on your machine. Earlier or later versions are not supported. Node.js also needs to be installed along with pnpm (can be installed with the command npm install -g pnpm if needed)

Open a command-line window on your machine. The PowerShell is recommended for Windows.
Create a directory to install InvokeAI into. You'll need at least 15 GB of free space:
```
mkdir invokeai
```
Create a virtual environment named .venv inside this directory and activate it:
```
cd invokeai
python -m venv .venv --prompt InvokeAI
```
Activate the virtual environment (do it every time you run InvokeAI)

For Linux/Mac users:
```
source .venv/bin/activate
```
For Windows users:
```
.venv\Scripts\activate
```

Install the InvokeAI module and its dependencies. Choose the command suited for your platform & GPU.

For Windows/Linux with an NVIDIA GPU:

pip install "InvokeAI[xformers]" --use-pep517 --extra-index-url https://download.pytorch.org/whl/cu121

For Linux with an AMD GPU:

pip install InvokeAI --use-pep517 --extra-index-url https://download.pytorch.org/whl/rocm5.4.2

For non-GPU systems:

pip install InvokeAI --use-pep517 --extra-index-url https://download.pytorch.org/whl/cpu

For Macintoshes, either Intel or M1/M2/M3:

pip install InvokeAI --use-pep517

Configure InvokeAI and install a starting set of image generation models (you only need to do this once):
```
invokeai-configure --root .
```
Don't miss the dot at the end!
Launch the web server (do it every time you run InvokeAI):
```
invokeai-web
```
Point your browser to http://localhost:9090 to bring up the web interface.
Type banana sushi in the box on the top left and click Invoke.

Be sure to activate the virtual environment each time before re-launching InvokeAI, using source .venv/bin/activate or .venv\Scripts\activate.

Detailed Installation Instructions

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

Migrating a v2.3 InvokeAI root directory

The InvokeAI root directory is where the InvokeAI startup file, installed models, and generated images are stored. It is ordinarily named invokeai and located in your home directory. The contents and layout of this directory has changed between versions 2.3 and 3.0 and cannot be used directly.

We currently recommend that you use the installer to create a new root directory named differently from the 2.3 one, e.g. invokeai-3 and then use a migration script to copy your 2.3 models into the new location. However, if you choose, you can upgrade this directory in place. This section gives both recipes.

Creating a new root directory and migrating old models

This is the safer recipe because it leaves your old root directory in place to fall back on.

Follow the instructions above to create and install InvokeAI in a directory that has a different name from the 2.3 invokeai directory. In this example, we will use "invokeai-3"
When you are prompted to select models to install, select a minimal set of models, such as stable-diffusion-v1.5 only.
After installation is complete launch invokeai.sh (Linux/Mac) or invokeai.bat and select option 8 "Open the developers console". This will take you to the command line.
Issue the command invokeai-migrate3 --from /path/to/v2.3-root --to /path/to/invokeai-3-root. Provide the correct --from and --to paths for your v2.3 and v3.0 root directories respectively.

This will copy and convert your old models from 2.3 format to 3.0 format and create a new models directory in the 3.0 directory. The old models directory (which contains the models selected at install time) will be renamed models.orig and can be deleted once you have confirmed that the migration was successful.

If you wish, you can pass the 2.3 root directory to both --from and --to in order to update in place. Warning: this directory will no longer be usable with InvokeAI 2.3.

Migrating in place

For the adventurous, you may do an in-place upgrade from 2.3 to 3.0 without touching the command line. *This recipe does not work on Windows platforms due to a bug in the Windows version of the 2.3 upgrade script. See the next section for a Windows recipe.

For Mac and Linux Users:

Launch the InvokeAI launcher script in your current v2.3 root directory.
Select option [9] "Update InvokeAI" to bring up the updater dialog.
Select option [1] to upgrade to the latest release.
Once the upgrade is finished you will be returned to the launcher menu. Select option [6] "Re-run the configure script to fix a broken install or to complete a major upgrade".

This will run the configure script against the v2.3 directory and update it to the 3.0 format. The following files will be replaced:

The invokeai.init file, replaced by invokeai.yaml
The models directory
The configs/models.yaml model index

The original versions of these files will be saved with the suffix ".orig" appended to the end. Once you have confirmed that the upgrade worked, you can safely remove these files. Alternatively you can restore a working v2.3 directory by removing the new files and restoring the ".orig" files' original names.

For Windows Users:

Windows Users can upgrade with the

Enter the 2.3 root directory you wish to upgrade
Launch invoke.sh or invoke.bat
Select the "Developer's console" option [8]
Type the following commands

pip install "invokeai @ https://github.com/invoke-ai/InvokeAI/archive/refs/tags/v3.0.0" --use-pep517 --upgrade
invokeai-configure --root .

(Replace v3.0.0 with the current release number if this document is out of date).

The first command will install and upgrade new software to run InvokeAI. The second will prepare the 2.3 directory for use with 3.0. You may now launch the WebUI in the usual way, by selecting option [1] from the launcher script

Migrating Images

The migration script will migrate your invokeai settings and models, including textual inversion models, LoRAs and merges that you may have installed previously. However it does not migrate the generated images stored in your 2.3-format outputs directory. To do this, you need to run an additional step:

From a working InvokeAI 3.0 root directory, start the launcher and enter menu option [8] to open the "developer's console".
At the developer's console command line, type the command:

invokeai-import-images

This will lead you through the process of confirming the desired source and destination for the imported images. The images will appear in the gallery board of your choice, and contain the original prompt, model name, and other parameters used to generate the image.

(Many kudos to techjedi for contributing this script.)

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 will need one of the following:

An NVIDIA-based graphics card with 4 GB or more VRAM memory. 6-8 GB of VRAM is highly recommended for rendering using the Stable Diffusion XL models
An Apple computer with an M1 chip.
An AMD-based graphics card with 4GB or more VRAM memory (Linux only), 6-8 GB for XL rendering.

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.

Features

Feature documentation can be reviewed by navigating to the InvokeAI Documentation page

Web Server & UI

InvokeAI offers a locally hosted Web Server & React Frontend, with an industry leading user experience. The Web-based UI allows for simple and intuitive workflows, and is responsive for use on mobile devices and tablets accessing the web server.

Unified Canvas

The Unified Canvas is a fully integrated canvas implementation with support for all core generation capabilities, in/outpainting, brush tools, and more. This creative tool unlocks the capability for artists to create with AI as a creative collaborator, and can be used to augment AI-generated imagery, sketches, photography, renders, and more.

Workflows & Nodes

InvokeAI offers a fully featured workflow management solution, enabling users to combine the power of nodes based workflows with the easy of a UI. This allows for customizable generation pipelines to be developed and shared by users looking to create specific workflows to support their production use-cases.

Board & Gallery Management

Invoke AI provides an organized gallery system for easily storing, accessing, and remixing your content in the Invoke workspace. Images can be dragged/dropped onto any Image-base UI element in the application, and rich metadata within the Image allows for easy recall of key prompts or settings used in your workflow.

Other features

Support for both ckpt and diffusers models
SD 2.0, 2.1, XL support
Upscaling Tools
Embedding Manager & Support
Model Manager & Support
Workflow creation & management
Node-Based Architecture

Latest Changes

For our latest changes, view our Release Notes and the CHANGELOG.

Troubleshooting

Please check out our Troubleshooting Guide to get solutions for common installation problems and other issues. For more help, please join our Discord

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.

Get started with contributing by reading our Contribution documentation, joining the #dev-chat or the GitHub discussion board.

If you are unfamiliar with how to contribute to GitHub projects, we have a new contributor checklist you can follow to get started contributing: New Contributor Checklist.

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, or join the Discord.