diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md index 9b4dfe1cfc..a4fce8d5ef 100644 --- a/docs/CHANGELOG.md +++ b/docs/CHANGELOG.md @@ -4,45 +4,228 @@ title: Changelog # :octicons-log-16: **Changelog** -## v2.0.1 (13 October 2022) +## v2.1.0 (2 November 2022) -- fix noisy images at high step count when using k* samplers -- dream.py script now calls invoke.py module directly rather than - via a new python process (which could break the environment) +- update mac instructions to use invokeai for env name by @willwillems in + https://github.com/invoke-ai/InvokeAI/pull/1030 +- Update .gitignore by @blessedcoolant in + https://github.com/invoke-ai/InvokeAI/pull/1040 +- reintroduce fix for m1 from https://github.com/invoke-ai/InvokeAI/pull/579 + missing after merge by @skurovec in + https://github.com/invoke-ai/InvokeAI/pull/1056 +- Update Stable_Diffusion_AI_Notebook.ipynb (Take 2) by @ChloeL19 in + https://github.com/invoke-ai/InvokeAI/pull/1060 +- Print out the device type which is used by @manzke in + https://github.com/invoke-ai/InvokeAI/pull/1073 +- Hires Addition by @hipsterusername in + https://github.com/invoke-ai/InvokeAI/pull/1063 +- fix for "1 leaked semaphore objects to clean up at shutdown" on M1 by + @skurovec in https://github.com/invoke-ai/InvokeAI/pull/1081 +- Forward dream.py to invoke.py using the same interpreter, add deprecation + warning by @db3000 in https://github.com/invoke-ai/InvokeAI/pull/1077 +- fix noisy images at high step counts by @lstein in + https://github.com/invoke-ai/InvokeAI/pull/1086 +- Generalize facetool strength argument by @db3000 in + https://github.com/invoke-ai/InvokeAI/pull/1078 +- Enable fast switching among models at the invoke> command line by @lstein in + https://github.com/invoke-ai/InvokeAI/pull/1066 +- Fix Typo, committed changing ldm environment to invokeai by @jdries3 in + https://github.com/invoke-ai/InvokeAI/pull/1095 +- Update generate.py by @unreleased in + https://github.com/invoke-ai/InvokeAI/pull/1109 +- Update 'ldm' env to 'invokeai' in troubleshooting steps by @19wolf in + https://github.com/invoke-ai/InvokeAI/pull/1125 +- Fixed documentation typos and resolved merge conflicts by @rupeshs in + https://github.com/invoke-ai/InvokeAI/pull/1123 +- Fix broken doc links, fix malaprop in the project subtitle by @majick in + https://github.com/invoke-ai/InvokeAI/pull/1131 +- Only output facetool parameters if enhancing faces by @db3000 in + https://github.com/invoke-ai/InvokeAI/pull/1119 +- Update gitignore to ignore codeformer weights at new location by + @spezialspezial in https://github.com/invoke-ai/InvokeAI/pull/1136 +- fix links to point to invoke-ai.github.io #1117 by @mauwii in + https://github.com/invoke-ai/InvokeAI/pull/1143 +- Rework-mkdocs by @mauwii in https://github.com/invoke-ai/InvokeAI/pull/1144 +- add option to CLI and pngwriter that allows user to set PNG compression level + by @lstein in https://github.com/invoke-ai/InvokeAI/pull/1127 +- Fix img2img DDIM index out of bound by @wfng92 in + https://github.com/invoke-ai/InvokeAI/pull/1137 +- Fix gh actions by @mauwii in https://github.com/invoke-ai/InvokeAI/pull/1128 +- update mac instructions to use invokeai for env name by @willwillems in + https://github.com/invoke-ai/InvokeAI/pull/1030 +- Update .gitignore by @blessedcoolant in + https://github.com/invoke-ai/InvokeAI/pull/1040 +- reintroduce fix for m1 from https://github.com/invoke-ai/InvokeAI/pull/579 + missing after merge by @skurovec in + https://github.com/invoke-ai/InvokeAI/pull/1056 +- Update Stable_Diffusion_AI_Notebook.ipynb (Take 2) by @ChloeL19 in + https://github.com/invoke-ai/InvokeAI/pull/1060 +- Print out the device type which is used by @manzke in + https://github.com/invoke-ai/InvokeAI/pull/1073 +- Hires Addition by @hipsterusername in + https://github.com/invoke-ai/InvokeAI/pull/1063 +- fix for "1 leaked semaphore objects to clean up at shutdown" on M1 by + @skurovec in https://github.com/invoke-ai/InvokeAI/pull/1081 +- Forward dream.py to invoke.py using the same interpreter, add deprecation + warning by @db3000 in https://github.com/invoke-ai/InvokeAI/pull/1077 +- fix noisy images at high step counts by @lstein in + https://github.com/invoke-ai/InvokeAI/pull/1086 +- Generalize facetool strength argument by @db3000 in + https://github.com/invoke-ai/InvokeAI/pull/1078 +- Enable fast switching among models at the invoke> command line by @lstein in + https://github.com/invoke-ai/InvokeAI/pull/1066 +- Fix Typo, committed changing ldm environment to invokeai by @jdries3 in + https://github.com/invoke-ai/InvokeAI/pull/1095 +- Fixed documentation typos and resolved merge conflicts by @rupeshs in + https://github.com/invoke-ai/InvokeAI/pull/1123 +- Only output facetool parameters if enhancing faces by @db3000 in + https://github.com/invoke-ai/InvokeAI/pull/1119 +- add option to CLI and pngwriter that allows user to set PNG compression level + by @lstein in https://github.com/invoke-ai/InvokeAI/pull/1127 +- Fix img2img DDIM index out of bound by @wfng92 in + https://github.com/invoke-ai/InvokeAI/pull/1137 +- Add text prompt to inpaint mask support by @lstein in + https://github.com/invoke-ai/InvokeAI/pull/1133 +- Respect http[s] protocol when making socket.io middleware by @damian0815 in + https://github.com/invoke-ai/InvokeAI/pull/976 +- WebUI: Adds Codeformer support by @psychedelicious in + https://github.com/invoke-ai/InvokeAI/pull/1151 +- Skips normalizing prompts for web UI metadata by @psychedelicious in + https://github.com/invoke-ai/InvokeAI/pull/1165 +- Add Asymmetric Tiling by @carson-katri in + https://github.com/invoke-ai/InvokeAI/pull/1132 +- Web UI: Increases max CFG Scale to 200 by @psychedelicious in + https://github.com/invoke-ai/InvokeAI/pull/1172 +- Corrects color channels in face restoration; Fixes #1167 by @psychedelicious + in https://github.com/invoke-ai/InvokeAI/pull/1175 +- Flips channels using array slicing instead of using OpenCV by @psychedelicious + in https://github.com/invoke-ai/InvokeAI/pull/1178 +- Fix typo in docs: s/Formally/Formerly by @noodlebox in + https://github.com/invoke-ai/InvokeAI/pull/1176 +- fix clipseg loading problems by @lstein in + https://github.com/invoke-ai/InvokeAI/pull/1177 +- Correct color channels in upscale using array slicing by @wfng92 in + https://github.com/invoke-ai/InvokeAI/pull/1181 +- Web UI: Filters existing images when adding new images; Fixes #1085 by + @psychedelicious in https://github.com/invoke-ai/InvokeAI/pull/1171 +- fix a number of bugs in textual inversion by @lstein in + https://github.com/invoke-ai/InvokeAI/pull/1190 +- Improve !fetch, add !replay command by @ArDiouscuros in + https://github.com/invoke-ai/InvokeAI/pull/882 +- Fix generation of image with s>1000 by @holstvoogd in + https://github.com/invoke-ai/InvokeAI/pull/951 +- Web UI: Gallery improvements by @psychedelicious in + https://github.com/invoke-ai/InvokeAI/pull/1198 +- Update CLI.md by @krummrey in https://github.com/invoke-ai/InvokeAI/pull/1211 +- outcropping improvements by @lstein in + https://github.com/invoke-ai/InvokeAI/pull/1207 +- add support for loading VAE autoencoders by @lstein in + https://github.com/invoke-ai/InvokeAI/pull/1216 +- remove duplicate fix_func for MPS by @wfng92 in + https://github.com/invoke-ai/InvokeAI/pull/1210 +- Metadata storage and retrieval fixes by @lstein in + https://github.com/invoke-ai/InvokeAI/pull/1204 +- nix: add shell.nix file by @Cloudef in + https://github.com/invoke-ai/InvokeAI/pull/1170 +- Web UI: Changes vite dist asset paths to relative by @psychedelicious in + https://github.com/invoke-ai/InvokeAI/pull/1185 +- Web UI: Removes isDisabled from PromptInput by @psychedelicious in + https://github.com/invoke-ai/InvokeAI/pull/1187 +- Allow user to generate images with initial noise as on M1 / mps system by + @ArDiouscuros in https://github.com/invoke-ai/InvokeAI/pull/981 +- feat: adding filename format template by @plucked in + https://github.com/invoke-ai/InvokeAI/pull/968 +- Web UI: Fixes broken bundle by @psychedelicious in + https://github.com/invoke-ai/InvokeAI/pull/1242 +- Support runwayML custom inpainting model by @lstein in + https://github.com/invoke-ai/InvokeAI/pull/1243 +- Update IMG2IMG.md by @talitore in + https://github.com/invoke-ai/InvokeAI/pull/1262 +- New dockerfile - including a build- and a run- script as well as a GH-Action + by @mauwii in https://github.com/invoke-ai/InvokeAI/pull/1233 +- cut over from karras to model noise schedule for higher steps by @lstein in + https://github.com/invoke-ai/InvokeAI/pull/1222 +- Prompt tweaks by @lstein in https://github.com/invoke-ai/InvokeAI/pull/1268 +- Outpainting implementation by @Kyle0654 in + https://github.com/invoke-ai/InvokeAI/pull/1251 +- fixing aspect ratio on hires by @tjennings in + https://github.com/invoke-ai/InvokeAI/pull/1249 +- Fix-build-container-action by @mauwii in + https://github.com/invoke-ai/InvokeAI/pull/1274 +- handle all unicode characters by @damian0815 in + https://github.com/invoke-ai/InvokeAI/pull/1276 +- adds models.user.yml to .gitignore by @JakeHL in + https://github.com/invoke-ai/InvokeAI/pull/1281 +- remove debug branch, set fail-fast to false by @mauwii in + https://github.com/invoke-ai/InvokeAI/pull/1284 +- Protect-secrets-on-pr by @mauwii in + https://github.com/invoke-ai/InvokeAI/pull/1285 +- Web UI: Adds initial inpainting implementation by @psychedelicious in + https://github.com/invoke-ai/InvokeAI/pull/1225 +- fix environment-mac.yml - tested on x64 and arm64 by @mauwii in + https://github.com/invoke-ai/InvokeAI/pull/1289 +- Use proper authentication to download model by @mauwii in + https://github.com/invoke-ai/InvokeAI/pull/1287 +- Prevent indexing error for mode RGB by @spezialspezial in + https://github.com/invoke-ai/InvokeAI/pull/1294 +- Integrate sd-v1-5 model into test matrix (easily expandable), remove + unecesarry caches by @mauwii in + https://github.com/invoke-ai/InvokeAI/pull/1293 +- add --no-interactive to preload_models step by @mauwii in + https://github.com/invoke-ai/InvokeAI/pull/1302 +- 1-click installer and updater. Uses micromamba to install git and conda into a + contained environment (if necessary) before running the normal installation + script by @cmdr2 in https://github.com/invoke-ai/InvokeAI/pull/1253 +- preload_models.py script downloads the weight files by @lstein in + https://github.com/invoke-ai/InvokeAI/pull/1290 + +## v2.0.1 (13 October 2022) + +- fix noisy images at high step count when using k\* samplers +- dream.py script now calls invoke.py module directly rather than via a new + python process (which could break the environment) ## v2.0.0 (9 October 2022) -- `dream.py` script renamed `invoke.py`. A `dream.py` script wrapper remains - for backward compatibility. +- `dream.py` script renamed `invoke.py`. A `dream.py` script wrapper remains for + backward compatibility. - Completely new WebGUI - launch with `python3 scripts/invoke.py --web` -- Support for [inpainting](features/INPAINTING.md) and [outpainting](features/OUTPAINTING.md) -- img2img runs on all k* samplers -- Support for [negative prompts](features/PROMPTS.md#negative-and-unconditioned-prompts) +- Support for [inpainting](features/INPAINTING.md) and + [outpainting](features/OUTPAINTING.md) +- img2img runs on all k\* samplers +- Support for + [negative prompts](features/PROMPTS.md#negative-and-unconditioned-prompts) - Support for CodeFormer face reconstruction - Support for Textual Inversion on Macintoshes -- Support in both WebGUI and CLI for [post-processing of previously-generated images](features/POSTPROCESS.md) - using facial reconstruction, ESRGAN upscaling, outcropping (similar to DALL-E infinite canvas), - and "embiggen" upscaling. See the `!fix` command. -- New `--hires` option on `invoke>` line allows [larger images to be created without duplicating elements](features/CLI.md#this-is-an-example-of-txt2img), at the cost of some performance. -- New `--perlin` and `--threshold` options allow you to add and control variation - during image generation (see [Thresholding and Perlin Noise Initialization](features/OTHER.md#thresholding-and-perlin-noise-initialization-options)) -- Extensive metadata now written into PNG files, allowing reliable regeneration of images - and tweaking of previous settings. -- Command-line completion in `invoke.py` now works on Windows, Linux and Mac platforms. -- Improved [command-line completion behavior](features/CLI.md) - New commands added: +- Support in both WebGUI and CLI for + [post-processing of previously-generated images](features/POSTPROCESS.md) + using facial reconstruction, ESRGAN upscaling, outcropping (similar to DALL-E + infinite canvas), and "embiggen" upscaling. See the `!fix` command. +- New `--hires` option on `invoke>` line allows + [larger images to be created without duplicating elements](features/CLI.md#this-is-an-example-of-txt2img), + at the cost of some performance. +- New `--perlin` and `--threshold` options allow you to add and control + variation during image generation (see + [Thresholding and Perlin Noise Initialization](features/OTHER.md#thresholding-and-perlin-noise-initialization-options)) +- Extensive metadata now written into PNG files, allowing reliable regeneration + of images and tweaking of previous settings. +- Command-line completion in `invoke.py` now works on Windows, Linux and Mac + platforms. +- Improved [command-line completion behavior](features/CLI.md) New commands + added: - List command-line history with `!history` - Search command-line history with `!search` - Clear history with `!clear` - Deprecated `--full_precision` / `-F`. Simply omit it and `invoke.py` will auto - configure. To switch away from auto use the new flag like `--precision=float32`. + configure. To switch away from auto use the new flag like + `--precision=float32`. ## v1.14 (11 September 2022) - Memory optimizations for small-RAM cards. 512x512 now possible on 4 GB GPUs. - Full support for Apple hardware with M1 or M2 chips. - Add "seamless mode" for circular tiling of image. Generates beautiful effects. - ([prixt](https://github.com/prixt)). + ([prixt](https://github.com/prixt)). - Inpainting support. - Improved web server GUI. - Lots of code and documentation cleanups. @@ -50,16 +233,17 @@ title: Changelog ## v1.13 (3 September 2022) - Support image variations (see [VARIATIONS](features/VARIATIONS.md) - ([Kevin Gibbons](https://github.com/bakkot) and many contributors and reviewers) -- Supports a Google Colab notebook for a standalone server running on Google hardware - [Arturo Mendivil](https://github.com/artmen1516) + ([Kevin Gibbons](https://github.com/bakkot) and many contributors and + reviewers) +- Supports a Google Colab notebook for a standalone server running on Google + hardware [Arturo Mendivil](https://github.com/artmen1516) - WebUI supports GFPGAN/ESRGAN facial reconstruction and upscaling - [Kevin Gibbons](https://github.com/bakkot) + [Kevin Gibbons](https://github.com/bakkot) - WebUI supports incremental display of in-progress images during generation - [Kevin Gibbons](https://github.com/bakkot) + [Kevin Gibbons](https://github.com/bakkot) - A new configuration file scheme that allows new models (including upcoming - stable-diffusion-v1.5) to be added without altering the code. - ([David Wager](https://github.com/maddavid12)) + stable-diffusion-v1.5) to be added without altering the code. + ([David Wager](https://github.com/maddavid12)) - Can specify --grid on invoke.py command line as the default. - Miscellaneous internal bug and stability fixes. - Works on M1 Apple hardware. @@ -71,49 +255,59 @@ title: Changelog - Improved file handling, including ability to read prompts from standard input. (kudos to [Yunsaki](https://github.com/yunsaki) -- The web server is now integrated with the invoke.py script. Invoke by adding --web to - the invoke.py command arguments. +- The web server is now integrated with the invoke.py script. Invoke by adding + --web to the invoke.py command arguments. - Face restoration and upscaling via GFPGAN and Real-ESGAN are now automatically enabled if the GFPGAN directory is located as a sibling to Stable Diffusion. - VRAM requirements are modestly reduced. Thanks to both [Blessedcoolant](https://github.com/blessedcoolant) and + VRAM requirements are modestly reduced. Thanks to both + [Blessedcoolant](https://github.com/blessedcoolant) and [Oceanswave](https://github.com/oceanswave) for their work on this. -- You can now swap samplers on the invoke> command line. [Blessedcoolant](https://github.com/blessedcoolant) +- You can now swap samplers on the invoke> command line. + [Blessedcoolant](https://github.com/blessedcoolant) --- ## v1.11 (26 August 2022) -- NEW FEATURE: Support upscaling and face enhancement using the GFPGAN module. (kudos to [Oceanswave](https://github.com/Oceanswave) -- You now can specify a seed of -1 to use the previous image's seed, -2 to use the seed for the image generated before that, etc. - Seed memory only extends back to the previous command, but will work on all images generated with the -n# switch. +- NEW FEATURE: Support upscaling and face enhancement using the GFPGAN module. + (kudos to [Oceanswave](https://github.com/Oceanswave) +- You now can specify a seed of -1 to use the previous image's seed, -2 to use + the seed for the image generated before that, etc. Seed memory only extends + back to the previous command, but will work on all images generated with the + -n# switch. - Variant generation support temporarily disabled pending more general solution. -- Created a feature branch named **yunsaki-morphing-invoke** which adds experimental support for - iteratively modifying the prompt and its parameters. Please see[Pull Request #86](https://github.com/lstein/stable-diffusion/pull/86) - for a synopsis of how this works. Note that when this feature is eventually added to the main branch, it will may be modified - significantly. +- Created a feature branch named **yunsaki-morphing-invoke** which adds + experimental support for iteratively modifying the prompt and its parameters. + Please + see[Pull Request #86](https://github.com/lstein/stable-diffusion/pull/86) for + a synopsis of how this works. Note that when this feature is eventually added + to the main branch, it will may be modified significantly. --- ## v1.10 (25 August 2022) -- A barebones but fully functional interactive web server for online generation of txt2img and img2img. +- A barebones but fully functional interactive web server for online generation + of txt2img and img2img. --- ## v1.09 (24 August 2022) - A new -v option allows you to generate multiple variants of an initial image - in img2img mode. (kudos to [Oceanswave](https://github.com/Oceanswave). [ - See this discussion in the PR for examples and details on use](https://github.com/lstein/stable-diffusion/pull/71#issuecomment-1226700810)) -- Added ability to personalize text to image generation (kudos to [Oceanswave](https://github.com/Oceanswave) and [nicolai256](https://github.com/nicolai256)) + in img2img mode. (kudos to [Oceanswave](https://github.com/Oceanswave). + [ See this discussion in the PR for examples and details on use](https://github.com/lstein/stable-diffusion/pull/71#issuecomment-1226700810)) +- Added ability to personalize text to image generation (kudos to + [Oceanswave](https://github.com/Oceanswave) and + [nicolai256](https://github.com/nicolai256)) - Enabled all of the samplers from k_diffusion --- ## v1.08 (24 August 2022) -- Escape single quotes on the invoke> command before trying to parse. This avoids - parse errors. +- Escape single quotes on the invoke> command before trying to parse. This + avoids parse errors. - Removed instruction to get Python3.8 as first step in Windows install. Anaconda3 does it for you. - Added bounds checks for numeric arguments that could cause crashes. @@ -123,34 +317,36 @@ title: Changelog ## v1.07 (23 August 2022) -- Image filenames will now never fill gaps in the sequence, but will be assigned the - next higher name in the chosen directory. This ensures that the alphabetic and chronological - sort orders are the same. +- Image filenames will now never fill gaps in the sequence, but will be assigned + the next higher name in the chosen directory. This ensures that the alphabetic + and chronological sort orders are the same. --- ## v1.06 (23 August 2022) -- Added weighted prompt support contributed by [xraxra](https://github.com/xraxra) -- Example of using weighted prompts to tweak a demonic figure contributed by [bmaltais](https://github.com/bmaltais) +- Added weighted prompt support contributed by + [xraxra](https://github.com/xraxra) +- Example of using weighted prompts to tweak a demonic figure contributed by + [bmaltais](https://github.com/bmaltais) --- ## v1.05 (22 August 2022 - after the drop) -- Filenames now use the following formats: - 000010.95183149.png -- Two files produced by the same command (e.g. -n2), - 000010.26742632.png -- distinguished by a different seed. +- Filenames now use the following formats: 000010.95183149.png -- Two files + produced by the same command (e.g. -n2), 000010.26742632.png -- distinguished + by a different seed. 000011.455191342.01.png -- Two files produced by the same command using 000011.455191342.02.png -- a batch size>1 (e.g. -b2). They have the same seed. - 000011.4160627868.grid#1-4.png -- a grid of four images (-g); the whole grid can - be regenerated with the indicated key + 000011.4160627868.grid#1-4.png -- a grid of four images (-g); the whole grid + can be regenerated with the indicated key - It should no longer be possible for one image to overwrite another -- You can use the "cd" and "pwd" commands at the invoke> prompt to set and retrieve - the path of the output directory. +- You can use the "cd" and "pwd" commands at the invoke> prompt to set and + retrieve the path of the output directory. --- @@ -164,26 +360,28 @@ title: Changelog ## v1.03 (22 August 2022) -- The original txt2img and img2img scripts from the CompViz repository have been moved into - a subfolder named "orig_scripts", to reduce confusion. +- The original txt2img and img2img scripts from the CompViz repository have been + moved into a subfolder named "orig_scripts", to reduce confusion. --- ## v1.02 (21 August 2022) -- A copy of the prompt and all of its switches and options is now stored in the corresponding - image in a tEXt metadata field named "Dream". You can read the prompt using scripts/images2prompt.py, - or an image editor that allows you to explore the full metadata. - **Please run "conda env update" to load the k_lms dependencies!!** +- A copy of the prompt and all of its switches and options is now stored in the + corresponding image in a tEXt metadata field named "Dream". You can read the + prompt using scripts/images2prompt.py, or an image editor that allows you to + explore the full metadata. **Please run "conda env update" to load the k_lms + dependencies!!** --- ## v1.01 (21 August 2022) -- added k_lms sampling. - **Please run "conda env update" to load the k_lms dependencies!!** -- use half precision arithmetic by default, resulting in faster execution and lower memory requirements - Pass argument --full_precision to invoke.py to get slower but more accurate image generation +- added k_lms sampling. **Please run "conda env update" to load the k_lms + dependencies!!** +- use half precision arithmetic by default, resulting in faster execution and + lower memory requirements Pass argument --full_precision to invoke.py to get + slower but more accurate image generation --- diff --git a/docs/index.md b/docs/index.md index 25275b56a9..de9ccb1f1d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -14,45 +14,67 @@ title: Home # ^^**InvokeAI: A Stable Diffusion Toolkit**^^ :tools:
Formerly known as lstein/stable-diffusion -![project logo](assets/logo.png) +[![project logo](assets/logo.png)](https://github.com/invoke-ai/InvokeAI) [![discord badge]][discord link] -[![latest release badge]][latest release link] [![github stars badge]][github stars link] [![github forks badge]][github forks link] +[![latest release badge]][latest release link] +[![github stars badge]][github stars link] +[![github forks badge]][github forks link] -[![CI checks on main badge]][CI checks on main link] [![CI checks on dev badge]][CI checks on dev link] [![latest commit to dev badge]][latest commit to dev link] +[![CI checks on main badge]][ci checks on main link] +[![CI checks on dev badge]][ci checks on dev link] +[![latest commit to dev badge]][latest commit to dev link] -[![github open issues badge]][github open issues link] [![github open prs badge]][github open prs link] +[![github open issues badge]][github open issues link] +[![github open prs badge]][github open prs link] -[CI checks on dev badge]: https://flat.badgen.net/github/checks/invoke-ai/InvokeAI/development?label=CI%20status%20on%20dev&cache=900&icon=github -[CI checks on dev link]: https://github.com/invoke-ai/InvokeAI/actions?query=branch%3Adevelopment -[CI checks on main badge]: https://flat.badgen.net/github/checks/invoke-ai/InvokeAI/main?label=CI%20status%20on%20main&cache=900&icon=github -[CI checks on main link]: https://github.com/invoke-ai/InvokeAI/actions/workflows/test-invoke-conda.yml +[ci checks on dev badge]: + https://flat.badgen.net/github/checks/invoke-ai/InvokeAI/development?label=CI%20status%20on%20dev&cache=900&icon=github +[ci checks on dev link]: + https://github.com/invoke-ai/InvokeAI/actions?query=branch%3Adevelopment +[ci checks on main badge]: + https://flat.badgen.net/github/checks/invoke-ai/InvokeAI/main?label=CI%20status%20on%20main&cache=900&icon=github +[ci checks on main link]: + https://github.com/invoke-ai/InvokeAI/actions/workflows/test-invoke-conda.yml [discord badge]: https://flat.badgen.net/discord/members/ZmtBAhwWhy?icon=discord [discord link]: https://discord.gg/ZmtBAhwWhy -[github forks badge]: https://flat.badgen.net/github/forks/invoke-ai/InvokeAI?icon=github -[github forks link]: https://useful-forks.github.io/?repo=lstein%2Fstable-diffusion -[github open issues badge]: https://flat.badgen.net/github/open-issues/invoke-ai/InvokeAI?icon=github -[github open issues link]: https://github.com/invoke-ai/InvokeAI/issues?q=is%3Aissue+is%3Aopen -[github open prs badge]: https://flat.badgen.net/github/open-prs/invoke-ai/InvokeAI?icon=github -[github open prs link]: https://github.com/invoke-ai/InvokeAI/pulls?q=is%3Apr+is%3Aopen -[github stars badge]: https://flat.badgen.net/github/stars/invoke-ai/InvokeAI?icon=github +[github forks badge]: + https://flat.badgen.net/github/forks/invoke-ai/InvokeAI?icon=github +[github forks link]: + https://useful-forks.github.io/?repo=lstein%2Fstable-diffusion +[github open issues badge]: + https://flat.badgen.net/github/open-issues/invoke-ai/InvokeAI?icon=github +[github open issues link]: + https://github.com/invoke-ai/InvokeAI/issues?q=is%3Aissue+is%3Aopen +[github open prs badge]: + https://flat.badgen.net/github/open-prs/invoke-ai/InvokeAI?icon=github +[github open prs link]: + https://github.com/invoke-ai/InvokeAI/pulls?q=is%3Apr+is%3Aopen +[github stars badge]: + https://flat.badgen.net/github/stars/invoke-ai/InvokeAI?icon=github [github stars link]: https://github.com/invoke-ai/InvokeAI/stargazers -[latest commit to dev badge]: https://flat.badgen.net/github/last-commit/invoke-ai/InvokeAI/development?icon=github&color=yellow&label=last%20dev%20commit&cache=900 -[latest commit to dev link]: https://github.com/invoke-ai/InvokeAI/commits/development -[latest release badge]: https://flat.badgen.net/github/release/invoke-ai/InvokeAI/development?icon=github +[latest commit to dev badge]: + https://flat.badgen.net/github/last-commit/invoke-ai/InvokeAI/development?icon=github&color=yellow&label=last%20dev%20commit&cache=900 +[latest commit to dev link]: + https://github.com/invoke-ai/InvokeAI/commits/development +[latest release badge]: + https://flat.badgen.net/github/release/invoke-ai/InvokeAI/development?icon=github [latest release link]: https://github.com/invoke-ai/InvokeAI/releases InvokeAI is an implementation of Stable Diffusion, the open source text-to-image and -image-to-image generator. It provides a streamlined process with -various new features and options to aid the image generation -process. It runs on Windows, Mac and Linux machines, and runs on GPU -cards with as little as 4 GB or RAM. +image-to-image generator. It provides a streamlined process with various new +features and options to aid the image generation process. It runs on Windows, +Mac and Linux machines, and runs on GPU cards with as little as 4 GB or RAM. -**Quick links**: [Discord Server] [Code and Downloads] [Bug Reports] [Discussion, Ideas & Q&A] +**Quick links**: [Discord Server] [Code and Downloads] [Bug Reports] [Discussion, Ideas & +Q&A]
@@ -62,8 +84,8 @@ cards with as little as 4 GB or RAM. ## :octicons-package-dependencies-24: Installation -This fork is supported across multiple platforms. You can find individual installation instructions -below. +This fork is supported across multiple platforms. You can find individual +installation instructions below. - :fontawesome-brands-linux: [Linux](installation/INSTALL_LINUX.md) - :fontawesome-brands-windows: [Windows](installation/INSTALL_WINDOWS.md) @@ -84,7 +106,8 @@ You wil need one of the following: ### :fontawesome-regular-hard-drive: Disk -- At least 12 GB of free disk space for the machine learning model, Python, and all its dependencies. +- At least 12 GB of free disk space for the machine learning model, Python, and + all its dependencies. !!! info @@ -93,8 +116,8 @@ You wil need one of the following: 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 + 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: ```bash @@ -103,73 +126,127 @@ You wil need one of the following: ## :octicons-log-16: Latest Changes +### v2.1.0 (2 November 2022) + +- [Inpainting](https://invoke-ai.github.io/InvokeAI/features/INPAINTING/) + support in the WebGUI +- Greatly improved navigation and user experience in the + [WebGUI](https://invoke-ai.github.io/InvokeAI/features/WEB/) +- The prompt syntax has been enhanced with + [prompt weighting, cross-attention and prompt merging](https://invoke-ai.github.io/InvokeAI/features/PROMPTS/). +- You can now load + [multiple models and switch among them quickly](https://docs.google.com/presentation/d/1WywGA1rny7bpFh7CLSdTr4nNpVKdlUeT0Bj0jCsILyU/edit?usp=sharing) + without leaving the CLI. +- The installation process (via `scripts/preload_models.py`) now lets you select + among several popular + [Stable Diffusion models](https://invoke-ai.github.io/InvokeAI/installation/INSTALLING_MODELS/) + and downloads and installs them on your behalf. Among other models, this + script will install the current Stable Diffusion 1.5 model as well as a + StabilityAI variable autoencoder (VAE) which improves face generation. +- Tired of struggling with photoeditors to get the masked region of for + inpainting just right? Let the AI make the mask for you using + [text masking](https://docs.google.com/presentation/d/1pWoY510hCVjz0M6X9CBbTznZgW2W5BYNKrmZm7B45q8/edit#slide=id.p). + This feature allows you to specify the part of the image to paint over using + just English-language phrases. +- Tired of seeing the head of your subjects cropped off? Uncrop them in the CLI + with the + [outcrop feature](https://invoke-ai.github.io/InvokeAI/features/OUTPAINTING/#outcrop). +- Tired of seeing your subject's bodies duplicated or mangled when generating + larger-dimension images? Check out the `--hires` option in the CLI, or select + the corresponding toggle in the WebGUI. +- We now support textual inversion and fine-tune .bin styles and subjects from + the Hugging Face archive of + [SD Concepts](https://huggingface.co/sd-concepts-library). Load the .bin file + using the `--embedding_path` option. (The next version will support merging + and loading of multiple simultaneous models). +- ... + ### v2.0.1 (13 October 2022) -- fix noisy images at high step count when using k* samplers -- dream.py script now calls invoke.py module directly rather than - via a new python process (which could break the environment) +- fix noisy images at high step count when using k\* samplers +- dream.py script now calls invoke.py module directly rather than via a new + python process (which could break the environment) ### v2.0.0 (9 October 2022) -- `dream.py` script renamed `invoke.py`. A `dream.py` script wrapper remains - for backward compatibility. +- `dream.py` script renamed `invoke.py`. A `dream.py` script wrapper remains for + backward compatibility. - Completely new WebGUI - launch with `python3 scripts/invoke.py --web` -- Support for inpainting and outpainting -- img2img runs on all k* samplers -- Support for negative prompts +- Support for + inpainting + and + outpainting +- img2img runs on all k\* samplers +- Support for + negative + prompts - Support for CodeFormer face reconstruction - Support for Textual Inversion on Macintoshes -- Support in both WebGUI and CLI for post-processing of previously-generated images - using facial reconstruction, ESRGAN upscaling, outcropping (similar to DALL-E infinite canvas), - and "embiggen" upscaling. See the `!fix` command. -- New `--hires` option on `invoke>` line allows larger images to be created without duplicating elements, at the cost of some performance. -- New `--perlin` and `--threshold` options allow you to add and control variation - during image generation (see Thresholding and Perlin Noise Initialization -- Extensive metadata now written into PNG files, allowing reliable regeneration of images - and tweaking of previous settings. -- Command-line completion in `invoke.py` now works on Windows, Linux and Mac platforms. -- Improved command-line completion behavior. - New commands added: +- Support in both WebGUI and CLI for + post-processing + of previously-generated images using facial reconstruction, ESRGAN + upscaling, outcropping (similar to DALL-E infinite canvas), and "embiggen" + upscaling. See the `!fix` command. +- New `--hires` option on `invoke>` line allows + larger + images to be created without duplicating elements, at the cost of some + performance. +- New `--perlin` and `--threshold` options allow you to add and control + variation during image generation (see + Thresholding + and Perlin Noise Initialization +- Extensive metadata now written into PNG files, allowing reliable regeneration + of images and tweaking of previous settings. +- Command-line completion in `invoke.py` now works on Windows, Linux and Mac + platforms. +- Improved + command-line + completion behavior. New commands added: - List command-line history with `!history` - Search command-line history with `!search` - Clear history with `!clear` - Deprecated `--full_precision` / `-F`. Simply omit it and `invoke.py` will auto - configure. To switch away from auto use the new flag like `--precision=float32`. + configure. To switch away from auto use the new flag like + `--precision=float32`. -For older changelogs, please visit the **[CHANGELOG](CHANGELOG.md#v114-11-september-2022)**. +For older changelogs, please visit the +**[CHANGELOG](CHANGELOG/#v114-11-september-2022)**. ## :material-target: Troubleshooting -Please check out our **[:material-frequently-asked-questions: Q&A](help/TROUBLESHOOT.md)** to get solutions for common installation -problems and other issues. +Please check out our +**[:material-frequently-asked-questions: Q&A](help/TROUBLESHOOT.md)** to get +solutions for common installation problems and other issues. ## :octicons-repo-push-24: 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. If you are unfamiliar with how -to contribute to GitHub projects, here is a +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. If you are unfamiliar with how to contribute to GitHub +projects, here is a [Getting Started Guide](https://opensource.com/article/19/7/create-pull-request-github). -A full set of contribution guidelines, along with templates, are in progress, but for now the most -important thing is to **make your pull request against the "development" branch**, and not against -"main". This will help keep public breakage to a minimum and will allow you to propose more radical -changes. +A full set of contribution guidelines, along with templates, are in progress, +but for now the most important thing is to **make your pull request against the +"development" branch**, and not against "main". This will help keep public +breakage to a minimum and will allow you to propose more radical changes. ## :octicons-person-24: Contributors This fork is a combined effort of various people from across the world. -[Check out the list of all these amazing people](other/CONTRIBUTORS.md). We thank them for their -time, hard work and effort. +[Check out the list of all these amazing people](other/CONTRIBUTORS.md). We +thank them for their time, hard work and effort. ## :octicons-question-24: 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. +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. Original portions of the software are Copyright (c) 2020 [Lincoln D. Stein](https://github.com/lstein) ## :octicons-book-24: Further Reading -Please see the original README for more information on this software and underlying algorithm, -located in the file [README-CompViz.md](other/README-CompViz.md). +Please see the original README for more information on this software and +underlying algorithm, located in the file +[README-CompViz.md](other/README-CompViz.md).