Release 3.0.0 RC Series (#3844)

## What type of PR is this? (check all applicable)

- [ X] Documentation Update


## Have you discussed this change with the InvokeAI team?
- [X ] Yes
- [ ] No, because:

## Description

This is a WIP to collect documentation enhancements and other polish
prior to final 3.0.0 release. Minor bug fixes may go in here if
non-controversial. It should be merged into main prior to the final
release.

Author: lstein

README.md

@@ -36,15 +36,6 @@
 
 </div>
 
-_**Note: This is an alpha release. Bugs are expected and not all
-features are fully implemented. Please use the GitHub [Issues
-pages](https://github.com/invoke-ai/InvokeAI/issues?q=is%3Aissue+is%3Aopen)
-to report unexpected problems. Also note that InvokeAI root directory
-which contains models, outputs and configuration files, has changed
-between the 2.x and 3.x release. If you wish to use your v2.3 root
-directory with v3.0, please follow the directions in [Migrating a 2.3
-root directory to 3.0](#migrating-to-3).**_
-
 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
@@ -264,19 +255,24 @@ 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. The recipe is as follows>
+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.
 
-3a. During the alpha release phase, select option [3] and manually
-enter the tag name `v3.0.0+a2`.
-
-3b. Once 3.0 is released, select option [1] to upgrade to the latest release.
+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 [7] "Re-run the configure script to fix a broken
@@ -295,14 +291,33 @@ 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
+
 #### Migration Caveats
 
 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. The released
-version of 3.0 is expected to have an interface for importing an
-entire directory of image files as a batch.
+images stored in your 2.3-format outputs directory. You will need to
+manually import selected images into the 3.0 gallery via drag-and-drop.
 
 ## Hardware Requirements
 
@@ -314,9 +329,12 @@ AMD card (using the ROCm driver).
 
 You will need one of the following:
 
-- An NVIDIA-based graphics card with 4 GB or more VRAM memory.
+- 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)
+- 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
@@ -349,13 +367,12 @@ Invoke AI provides an organized gallery system for easily storing, accessing, an
 ### Other features
 
 - *Support for both ckpt and diffusers models*
-- *SD 2.0, 2.1 support*
+- *SD 2.0, 2.1, XL support*
 - *Upscaling Tools*
 - *Embedding Manager & Support*
 - *Model Manager & Support*
 - *Node-Based Architecture*
 - *Node-Based Plug-&-Play UI (Beta)*
-- *SDXL Support* (Coming soon)
 
 ### Latest Changes
 

docs/assets/sdxl-graphs/sdxl-base-example1.json

@@ -0,0 +1 @@
+{"nodes":[{"width":387,"height":565,"dragHandle":".node-drag-handle","id":"800b3166-5044-4987-ba13-f839963fec96","type":"invocation","position":{"x":-169.10829044927982,"y":-272.36451106154334},"data":{"id":"800b3166-5044-4987-ba13-f839963fec96","type":"sdxl_compel_prompt","inputs":{"prompt":{"id":"8e76febd-6692-4a40-8bba-cbac54bccf1a","name":"prompt","type":"string","value":"bluebird in a sakura tree"},"style":{"id":"cd0e7434-04d8-4e36-b08b-3342d6ab4caa","name":"style","type":"string","value":""},"original_width":{"id":"cd259354-c92c-4e1c-815a-205fb38f8fec","name":"original_width","type":"integer","value":1024},"original_height":{"id":"b5cebf0e-97ce-4cd3-92be-fad37472daf2","name":"original_height","type":"integer","value":1024},"crop_top":{"id":"e6763334-676e-42fd-9fbf-0537ff002013","name":"crop_top","type":"integer","value":0},"crop_left":{"id":"00042856-acd5-4f99-a0e1-2d0b567ebf0f","name":"crop_left","type":"integer","value":0},"target_width":{"id":"800e17aa-1c15-4cdc-bceb-1f3f3ef5d244","name":"target_width","type":"integer","value":1024},"target_height":{"id":"91079f90-886b-440f-8236-236a239af747","name":"target_height","type":"integer","value":1024},"clip":{"id":"b32c84f8-b39e-4c23-8a77-fc62944ef942","name":"clip","type":"clip"},"clip2":{"id":"80db777a-3e3d-4132-ba0b-75a0b2135809","name":"clip2","type":"clip"}},"outputs":{"conditioning":{"id":"ea368e7a-bc93-4492-8fc6-e1d2fe2f5e2a","name":"conditioning","type":"conditioning"}}},"selected":false,"positionAbsolute":{"x":-169.10829044927982,"y":-272.36451106154334},"dragging":false},{"width":387,"height":565,"dragHandle":".node-drag-handle","id":"f3b94b55-bd55-4244-87b2-bf92e4ebbd2a","type":"invocation","position":{"x":-173.7213091998297,"y":346.42482955878256},"data":{"id":"f3b94b55-bd55-4244-87b2-bf92e4ebbd2a","type":"sdxl_compel_prompt","inputs":{"prompt":{"id":"d718b007-51f9-4385-bbf9-fa99756d5a4c","name":"prompt","type":"string","value":""},"style":{"id":"6476aafe-9e17-48b2-b66c-fbb8ff555926","name":"style","type":"string","value":""},"original_width":{"id":"7f4cf0bd-d5ab-460f-9484-375160f87620","name":"original_width","type":"integer","value":1024},"original_height":{"id":"8c1695a7-2b1b-44ba-8644-da207c551366","name":"original_height","type":"integer","value":1024},"crop_top":{"id":"5e7e7434-e966-4592-a422-924784192719","name":"crop_top","type":"integer","value":0},"crop_left":{"id":"cbbbc129-c481-4a28-a944-ad894dcec8b1","name":"crop_left","type":"integer","value":0},"target_width":{"id":"18bb5fb9-d488-41c3-9d8b-1b0e5b163676","name":"target_width","type":"integer","value":1024},"target_height":{"id":"44cbc645-b582-48c7-9e37-8aabd2615355","name":"target_height","type":"integer","value":1024},"clip":{"id":"65f8cad6-9aaf-4d21-91af-e9aeb9657bf2","name":"clip","type":"clip"},"clip2":{"id":"db5cdf20-9968-4932-b7de-adbc2460ca31","name":"clip2","type":"clip"}},"outputs":{"conditioning":{"id":"4f0236e9-0bf1-4410-867d-7241f1fe3e4c","name":"conditioning","type":"conditioning"}}},"selected":false,"positionAbsolute":{"x":-173.7213091998297,"y":346.42482955878256},"dragging":false},{"width":334,"height":269,"dragHandle":".node-drag-handle","id":"e29a9d29-2f63-487b-89b8-4184b1871c8f","type":"invocation","position":{"x":-652.2340297939481,"y":338.43526096363286},"data":{"id":"e29a9d29-2f63-487b-89b8-4184b1871c8f","type":"sdxl_model_loader","inputs":{"model":{"id":"4b19dda6-31fe-4317-a741-a19f8d8ec18f","name":"model","type":"model","value":{"model_name":"stable-diffusion-xl-base-0.9","base_model":"sdxl"}}},"outputs":{"unet":{"id":"d816da3a-7cb9-4d0d-8b1a-cea4e596c11e","name":"unet","type":"unet"},"clip":{"id":"35af0240-3014-4a2e-b3f2-f79ddffaca29","name":"clip","type":"clip"},"clip2":{"id":"25360ee2-ce84-4d04-95d6-a6e63db7e87c","name":"clip2","type":"clip"},"vae":{"id":"e8f15338-cbbe-45a1-8248-059b3601b058","name":"vae","type":"vae"}}},"selected":false,"positionAbsolute":{"x":-652.2340297939481,"y":338.43526096363286},"dragging":false},{"width":384,"height":519,"dragHandle":".node-drag-handle","id":"41f3e341-a2ae-4741-b0cd-dea20abde273","type":"invocation","position":{"x":796.6378578223604,"y":-192.53063049405188},"data":{"id":"41f3e341-a2ae-4741-b0cd-dea20abde273","type":"t2l_sdxl","inputs":{"positive_conditioning":{"id":"2b679eb8-3d15-4b4c-9a68-334bf43ea3d3","name":"positive_conditioning","type":"conditioning"},"negative_conditioning":{"id":"d3cfcf4b-8b31-4f88-98ed-3486dd60fa6f","name":"negative_conditioning","type":"conditioning"},"noise":{"id":"ed624337-7042-4a28-adf1-c8a6def87b4c","name":"noise","type":"latents"},"steps":{"id":"92f299da-c6ec-45fc-ad3d-d6af0f9862e6","name":"steps","type":"integer","value":10},"cfg_scale":{"id":"b129fa4e-c772-48cd-9dad-9b7223ddfcf5","name":"cfg_scale","type":"float","value":7.5},"scheduler":{"id":"d5e86735-8301-42f4-8fc4-276120e444cd","name":"scheduler","type":"enum","value":"euler"},"unet":{"id":"9affc51f-37a9-4468-90c9-bec97efda3f4","name":"unet","type":"unet"},"denoising_end":{"id":"91f41083-910e-4955-b3ae-d93ad3d1d801","name":"denoising_end","type":"float","value":1}},"outputs":{"latents":{"id":"f6b119cc-cf8d-46c0-8f43-bf712c509938","name":"latents","type":"latents"},"width":{"id":"cfcced65-62b2-40c7-b2bf-6534220eeaa1","name":"width","type":"integer"},"height":{"id":"819fbf37-8db1-4f5c-ad6b-a5cdb71e8c9a","name":"height","type":"integer"}}},"selected":false,"positionAbsolute":{"x":796.6378578223604,"y":-192.53063049405188},"dragging":false},{"width":333,"height":344,"dragHandle":".node-drag-handle","id":"357773ee-386a-423a-a712-a23812554cbb","type":"invocation","position":{"x":401.8907147451813,"y":576.7882372082732},"data":{"id":"357773ee-386a-423a-a712-a23812554cbb","type":"noise","inputs":{"seed":{"id":"9eaa6f6f-bde4-42b6-945a-a09b6cc46531","name":"seed","type":"integer","value":10},"width":{"id":"241032d2-6d05-47c1-bf9e-1a13ef95956b","name":"width","type":"integer","value":1024},"height":{"id":"71eda9a5-4460-4e7e-ba7a-2d99fa47ddf5","name":"height","type":"integer","value":1024},"use_cpu":{"id":"1dd54a91-deaa-4b83-be89-230c517d7b6b","name":"use_cpu","type":"boolean","value":true}},"outputs":{"noise":{"id":"321604ef-b33b-4529-91af-0d8d03d23f2f","name":"noise","type":"latents"},"width":{"id":"fc1f68f3-720f-4dbe-a9c9-b8a08cca768a","name":"width","type":"integer"},"height":{"id":"61022078-48f5-4faf-923e-9cddb508be30","name":"height","type":"integer"}}},"selected":false,"positionAbsolute":{"x":401.8907147451813,"y":576.7882372082732},"dragging":false},{"width":250,"height":323,"dragHandle":".node-drag-handle","id":"3e712379-88e7-465d-94d1-e06160b7cfae","type":"invocation","position":{"x":1237.2519670580534,"y":257.58346014925485},"data":{"id":"3e712379-88e7-465d-94d1-e06160b7cfae","type":"l2i","inputs":{"latents":{"id":"453d1aac-7bfe-480b-bc6f-2c3b110cd9b8","name":"latents","type":"latents"},"vae":{"id":"c7c38097-3620-4eb8-aec5-4ce1b043bb83","name":"vae","type":"vae"},"tiled":{"id":"2cab559e-fbaa-4cbf-ae9b-e5e43df38369","name":"tiled","type":"boolean","value":false},"fp32":{"id":"daf6c8df-325a-4cf6-9e86-d8962d838f17","name":"fp32","type":"boolean","value":true}},"outputs":{"image":{"id":"6ead6575-d4ad-4dd2-b6e0-5b70f9cce726","name":"image","type":"image"},"width":{"id":"734a4436-2c6f-4c57-b1cb-25a01548031d","name":"width","type":"integer"},"height":{"id":"7a03a4af-ab06-43f3-bb4d-1789b6f2c5e9","name":"height","type":"integer"}}},"selected":false,"positionAbsolute":{"x":1237.2519670580534,"y":257.58346014925485},"dragging":false},{"width":320,"height":187,"dragHandle":".node-drag-handle","id":"2423e526-ba3c-448e-8240-7442508d4609","type":"invocation","position":{"x":-33.59691285742994,"y":945.2263448868741},"data":{"id":"2423e526-ba3c-448e-8240-7442508d4609","type":"rand_int","inputs":{"low":{"id":"70ffaec8-3064-45dc-8b5c-6b4f43cc3b62","name":"low","type":"integer","value":0},"high":{"id":"82e10321-ce31-4e86-9e21-077c16a18e3d","name":"high","type":"integer","value":2147483647}},"outputs":{"a":{"id":"bba34654-8a92-40db-9810-7f75ddad8ae9","name":"a","type":"integer"}}},"selected":true,"positionAbsolute":{"x":-33.59691285742994,"y":945.2263448868741},"dragging":false}],"edges":[{"source":"41f3e341-a2ae-4741-b0cd-dea20abde273","sourceHandle":"latents","target":"3e712379-88e7-465d-94d1-e06160b7cfae","targetHandle":"latents","id":"reactflow__edge-41f3e341-a2ae-4741-b0cd-dea20abde273latents-3e712379-88e7-465d-94d1-e06160b7cfaelatents"},{"source":"800b3166-5044-4987-ba13-f839963fec96","sourceHandle":"conditioning","target":"41f3e341-a2ae-4741-b0cd-dea20abde273","targetHandle":"positive_conditioning","id":"reactflow__edge-800b3166-5044-4987-ba13-f839963fec96conditioning-41f3e341-a2ae-4741-b0cd-dea20abde273positive_conditioning"},{"source":"f3b94b55-bd55-4244-87b2-bf92e4ebbd2a","sourceHandle":"conditioning","target":"41f3e341-a2ae-4741-b0cd-dea20abde273","targetHandle":"negative_conditioning","id":"reactflow__edge-f3b94b55-bd55-4244-87b2-bf92e4ebbd2aconditioning-41f3e341-a2ae-4741-b0cd-dea20abde273negative_conditioning"},{"source":"357773ee-386a-423a-a712-a23812554cbb","sourceHandle":"noise","target":"41f3e341-a2ae-4741-b0cd-dea20abde273","targetHandle":"noise","id":"reactflow__edge-357773ee-386a-423a-a712-a23812554cbbnoise-41f3e341-a2ae-4741-b0cd-dea20abde273noise"},{"source":"e29a9d29-2f63-487b-89b8-4184b1871c8f","sourceHandle":"vae","target":"3e712379-88e7-465d-94d1-e06160b7cfae","targetHandle":"vae","id":"reactflow__edge-e29a9d29-2f63-487b-89b8-4184b1871c8fvae-3e712379-88e7-465d-94d1-e06160b7cfaevae"},{"source":"e29a9d29-2f63-487b-89b8-4184b1871c8f","sourceHandle":"clip","target":"800b3166-5044-4987-ba13-f839963fec96","targetHandle":"clip","id":"reactflow__edge-e29a9d29-2f63-487b-89b8-4184b1871c8fclip-800b3166-5044-4987-ba13-f839963fec96clip"},{"source":"e29a9d29-2f63-487b-89b8-4184b1871c8f","sourceHandle":"clip2","target":"800b3166-5044-4987-ba13-f839963fec96","targetHandle":"clip2","id":"reactflow__edge-e29a9d29-2f63-487b-89b8-4184b1871c8fclip2-800b3166-5044-4987-ba13-f839963fec96clip2"},{"source":"e29a9d29-2f63-487b-89b8-4184b1871c8f","sourceHandle":"clip","target":"f3b94b55-bd55-4244-87b2-bf92e4ebbd2a","targetHandle":"clip","id":"reactflow__edge-e29a9d29-2f63-487b-89b8-4184b1871c8fclip-f3b94b55-bd55-4244-87b2-bf92e4ebbd2aclip"},{"source":"e29a9d29-2f63-487b-89b8-4184b1871c8f","sourceHandle":"clip2","target":"f3b94b55-bd55-4244-87b2-bf92e4ebbd2a","targetHandle":"clip2","id":"reactflow__edge-e29a9d29-2f63-487b-89b8-4184b1871c8fclip2-f3b94b55-bd55-4244-87b2-bf92e4ebbd2aclip2"},{"source":"e29a9d29-2f63-487b-89b8-4184b1871c8f","sourceHandle":"unet","target":"41f3e341-a2ae-4741-b0cd-dea20abde273","targetHandle":"unet","id":"reactflow__edge-e29a9d29-2f63-487b-89b8-4184b1871c8funet-41f3e341-a2ae-4741-b0cd-dea20abde273unet"},{"source":"2423e526-ba3c-448e-8240-7442508d4609","sourceHandle":"a","target":"357773ee-386a-423a-a712-a23812554cbb","targetHandle":"seed","id":"reactflow__edge-2423e526-ba3c-448e-8240-7442508d4609a-357773ee-386a-423a-a712-a23812554cbbseed"}],"viewport":{"x":473.83885376565604,"y":374.3473116493717,"zoom":0.5904963307147653}}

docs/assets/sdxl-graphs/sdxl-base-refine-example1.json

@@ -58,7 +58,8 @@ class ApiDependencies:
 
     @staticmethod
     def initialize(config: InvokeAIAppConfig, event_handler_id: int, logger: Logger = logger):
-        logger.debug(f"InvokeAI version {__version__}")
+        logger.info(f"InvokeAI version {__version__}")
+        logger.info(f"Root directory = {str(config.root_path)}")
         logger.debug(f"Internet connectivity is {config.internet_available}")
 
         events = FastAPIEventService(event_handler_id)