documentation tweaks

invoke-ai · Sep 11, 2022 · 878ef2e · 878ef2e
1 parent 4923118
commit 878ef2e
Show file tree

Hide file tree

Showing 2 changed files with 44 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -14,9 +14,17 @@
 
 # **Stable Diffusion Dream Script**
 
-This is a fork of [CompVis/stable-diffusion](https://github.com/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.
-
-_Note: This fork is rapidly evolving. Please use the [Issues](https://github.com/lstein/stable-diffusion/issues) tab to report bugs and make feature requests. Be sure to use the provided templates. They will help aid diagnose issues faster._
+This is a fork of
+[CompVis/stable-diffusion](https://github.com/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, Mac and Linux machines,
+and runs on GPU cards with as little as 4 GB or RAM.
+
+_Note: This fork is rapidly evolving. Please use the
+[Issues](https://github.com/lstein/stable-diffusion/issues) tab to
+report bugs and make feature requests. Be sure to use the provided
+templates. They will help aid diagnose issues faster._
 
 # **Table of Contents**
 
@@ -41,7 +49,7 @@ This fork is supported across multiple platforms. You can find individual instal
 
 You wil need one of the following:
 
-- An NVIDIA-based graphics card with 8 GB or more VRAM memory.
+- An NVIDIA-based graphics card with 4 GB or more VRAM memory.
 - An Apple computer with an M1 chip.
 
 **Memory**
@@ -54,11 +62,13 @@ You wil need one of the following:
 
 **Note**
 
-If you are have a Nvidia 10xx series card (e.g. the 1080ti), please run the dream script in full-precision mode as shown below.
+If you are 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.
 
-To run in full-precision mode, start `dream.py` with the `--full_precision` flag:
+To run in full-precision mode, start `dream.py` with the
+`--full_precision` flag:
 
 ```
 (ldm) ~/stable-diffusion$ python scripts/dream.py --full_precision
@@ -72,6 +82,8 @@ To run in full-precision mode, start `dream.py` with the `--full_precision` flag
 
 - ## [Image To Image](docs/features/IMG2IMG.md)
 
+- ## [Inpainting Support](docs/features/INPAINTING.md)
+
 - ## [GFPGAN and Real-ESRGAN Support](docs/features/UPSCALE.md)
 
 - ## [Seamless Tiling](docs/features/OTHER.md#seamless-tiling)
@@ -100,9 +112,14 @@ To run in full-precision mode, start `dream.py` with the `--full_precision` flag
 
 # Latest Changes
 
-- v1.14 (In progress)
+- v1.14 (11 September 2022)
 
-  - Add "seamless mode" for circular tiling of image. Generates beautiful effects. ([prixt](https://github.com/prixt))
+  - 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)).
+  - Inpainting support.
+  - Improved web server GUI.
+  - Lots of code and documentation cleanups.
 
 - v1.13 (3 September 2022
 

diff --git a/docs/features/INPAINTING.md b/docs/features/INPAINTING.md
@@ -1,10 +1,24 @@
 # **Creating Transparent Regions for Inpainting**
 
-Inpainting is really cool. To do it, you start with an initial image and use a photoeditor to make one or more regions transparent (i.e. they have a "hole" in them). You then provide the path to this image at the dream> command line using the `-I` switch. Stable Diffusion will only paint within the transparent region.
-
-There's a catch. In the current implementation, you have to prepare the initial image correctly so that the underlying colors are preserved under the transparent area. Many imaging editing applications will by default erase the color information under the transparent pixels and replace them with white or black, which will lead to suboptimal inpainting. You also must take care to export the PNG file in such a way that the color information is preserved.
-
-If your photoeditor is erasing the underlying color information, `dream.py` will give you a big fat warning. If you can't find a way to coax your photoeditor to retain color values under transparent areas, then you can combine the `-I` and `-M` switches to provide both the original unedited image and the masked (partially transparent) image:
+Inpainting is really cool. To do it, you start with an initial image
+and use a photoeditor to make one or more regions transparent
+(i.e. they have a "hole" in them). You then provide the path to this
+image at the dream> command line using the `-I` switch. Stable
+Diffusion will only paint within the transparent region.
+
+There's a catch. In the current implementation, you have to prepare
+the initial image correctly so that the underlying colors are
+preserved under the transparent area. Many imaging editing
+applications will by default erase the color information under the
+transparent pixels and replace them with white or black, which will
+lead to suboptimal inpainting. You also must take care to export the
+PNG file in such a way that the color information is preserved.
+
+If your photoeditor is erasing the underlying color information,
+`dream.py` will give you a big fat warning. If you can't find a way to
+coax your photoeditor to retain color values under transparent areas,
+then you can combine the `-I` and `-M` switches to provide both the
+original unedited image and the masked (partially transparent) image:
 
 ```
 dream> man with cat on shoulder -I./images/man.png -M./images/man-transparent.png