mirror of
https://github.com/invoke-ai/InvokeAI
synced 2024-08-30 20:32:17 +00:00
Update README.md
This commit is contained in:
parent
398f37c0ed
commit
dac2d78da6
141
README.md
141
README.md
@ -117,7 +117,7 @@ Linux/Mac systems, and `C:\Users\YourName\invokeai` on Windows. This directory w
|
|||||||
macOS, open a Terminal window, drag `invoke.sh` from the folder into
|
macOS, open a Terminal window, drag `invoke.sh` from the folder into
|
||||||
the Terminal, and press return. On Linux, run `invoke.sh`
|
the Terminal, and press return. On Linux, run `invoke.sh`
|
||||||
|
|
||||||
9. Press 2 to open the "browser-based UI", press enter/return, wait a
|
9. Press 1 to open the "browser-based UI", press enter/return, wait a
|
||||||
minute or two for Stable Diffusion to start up, then open your browser
|
minute or two for Stable Diffusion to start up, then open your browser
|
||||||
and go to http://localhost:9090.
|
and go to http://localhost:9090.
|
||||||
|
|
||||||
@ -183,22 +183,15 @@ the command `npm install -g pnpm` if needed)
|
|||||||
pip install InvokeAI --use-pep517
|
pip install InvokeAI --use-pep517
|
||||||
```
|
```
|
||||||
|
|
||||||
6. Configure InvokeAI and install a starting set of image generation models (you only need to do this once):
|
6. Launch the web server (do it every time you run InvokeAI):
|
||||||
|
|
||||||
```terminal
|
|
||||||
invokeai-configure --root .
|
|
||||||
```
|
|
||||||
Don't miss the dot at the end!
|
|
||||||
|
|
||||||
7. Launch the web server (do it every time you run InvokeAI):
|
|
||||||
|
|
||||||
```terminal
|
```terminal
|
||||||
invokeai-web
|
invokeai-web
|
||||||
```
|
```
|
||||||
|
|
||||||
8. Point your browser to http://localhost:9090 to bring up the web interface.
|
7. Point your browser to http://localhost:9090 to bring up the web interface.
|
||||||
|
|
||||||
9. Type `banana sushi` in the box on the top left and click `Invoke`.
|
8. 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,
|
Be sure to activate the virtual environment each time before re-launching InvokeAI,
|
||||||
using `source .venv/bin/activate` or `.venv\Scripts\activate`.
|
using `source .venv/bin/activate` or `.venv\Scripts\activate`.
|
||||||
@ -211,128 +204,6 @@ AMD card (using the ROCm driver). For full installation and upgrade
|
|||||||
instructions, please see:
|
instructions, please see:
|
||||||
[InvokeAI Installation Overview](https://invoke-ai.github.io/InvokeAI/installation/INSTALL_SOURCE/)
|
[InvokeAI Installation Overview](https://invoke-ai.github.io/InvokeAI/installation/INSTALL_SOURCE/)
|
||||||
|
|
||||||
<a name="migrating-to-3"></a>
|
|
||||||
### 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.
|
|
||||||
|
|
||||||
1. 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"
|
|
||||||
|
|
||||||
2. When you are prompted to select models to install, select a minimal
|
|
||||||
set of models, such as stable-diffusion-v1.5 only.
|
|
||||||
|
|
||||||
3. 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.
|
|
||||||
|
|
||||||
4. 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:
|
|
||||||
|
|
||||||
1. Launch the InvokeAI launcher script in your current v2.3 root directory.
|
|
||||||
|
|
||||||
2. Select option [9] "Update InvokeAI" to bring up the updater dialog.
|
|
||||||
|
|
||||||
3. Select option [1] to upgrade to the latest release.
|
|
||||||
|
|
||||||
4. 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
|
|
||||||
|
|
||||||
1. Enter the 2.3 root directory you wish to upgrade
|
|
||||||
2. Launch `invoke.sh` or `invoke.bat`
|
|
||||||
3. Select the "Developer's console" option [8]
|
|
||||||
4. 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:
|
|
||||||
|
|
||||||
1. From a working InvokeAI 3.0 root directory, start the launcher and
|
|
||||||
enter menu option [8] to open the "developer's console".
|
|
||||||
|
|
||||||
2. At the developer's console command line, type the command:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
invokeai-import-images
|
|
||||||
```
|
|
||||||
|
|
||||||
3. 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
|
## Hardware Requirements
|
||||||
|
|
||||||
InvokeAI is supported across Linux, Windows and macOS. Linux
|
InvokeAI is supported across Linux, Windows and macOS. Linux
|
||||||
@ -381,7 +252,7 @@ Invoke AI provides an organized gallery system for easily storing, accessing, an
|
|||||||
### Other features
|
### Other features
|
||||||
|
|
||||||
- *Support for both ckpt and diffusers models*
|
- *Support for both ckpt and diffusers models*
|
||||||
- *SD 2.0, 2.1, XL support*
|
- *SD1.5, SD2.0, and SDXL support*
|
||||||
- *Upscaling Tools*
|
- *Upscaling Tools*
|
||||||
- *Embedding Manager & Support*
|
- *Embedding Manager & Support*
|
||||||
- *Model Manager & Support*
|
- *Model Manager & Support*
|
||||||
@ -427,5 +298,5 @@ their time, hard work and effort.
|
|||||||
|
|
||||||
For support, please use this repository's GitHub Issues tracking service, or join the [Discord][discord link].
|
For support, please use this repository's GitHub Issues tracking service, or join the [Discord][discord link].
|
||||||
|
|
||||||
Original portions of the software are Copyright (c) 2023 by respective contributors.
|
Original portions of the software are Copyright (c) 2024 by respective contributors.
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user