..masked.png
+
+The `.masked.png` file can then be directly passed to the `invoke>`
+prompt in the CLI via the `-M` argument. Do not attempt this with
+the `selected.png` or `deselected.png` files, as they contain some
+transparency throughout the image and will not produce the desired
+results.
+
+Here is an example of how `!mask` works:
+
+```
+invoke> !mask ./test-pictures/curly.png -tm hair 0.5
+>> generating masks from ./test-pictures/curly.png
+>> Initializing clipseg model for text to mask inference
+Outputs:
+[941.1] outputs/img-samples/000019.curly.hair.deselected.png: !mask ./test-pictures/curly.png -tm hair 0.5
+[941.2] outputs/img-samples/000019.curly.hair.selected.png: !mask ./test-pictures/curly.png -tm hair 0.5
+[941.3] outputs/img-samples/000019.curly.hair.masked.png: !mask ./test-pictures/curly.png -tm hair 0.5
+```
+
+**Original image "curly.png"**
+
+
+**000019.curly.hair.selected.png**
+
+
+**000019.curly.hair.deselected.png**
+
+
+**000019.curly.hair.masked.png**
+
+
+It looks like we selected the hair pretty well at the 0.5 threshold
+(which is the default, so we didn't actually have to specify it), so
+let's have some fun:
+
+```
+invoke> medusa with cobras -I ./test-pictures/curly.png -M 000019.curly.hair.masked.png -C20
+>> loaded input image of size 512x512 from ./test-pictures/curly.png
+...
+Outputs:
+[946] outputs/img-samples/000024.801380492.png: "medusa with cobras" -s 50 -S 801380492 -W 512 -H 512 -C 20.0 -I ./test-pictures/curly.png -A k_lms -f 0.75
+```
+
+
+
+You can also skip the `!mask` creation step and just select the masked
+
+region directly:
+```
+invoke> medusa with cobras -I ./test-pictures/curly.png -tm hair -C20
+```
+
+### Inpainting is not changing the masked region enough!
+
+One of the things to understand about how inpainting works is that it
+is equivalent to running img2img on just the masked (transparent)
+area. img2img builds on top of the existing image data, and therefore
+will attempt to preserve colors, shapes and textures to the best of
+its ability. Unfortunately this means that if you want to make a
+dramatic change in the inpainted region, for example replacing a red
+wall with a blue one, the algorithm will fight you.
+
+You have a couple of options. The first is to increase the values of
+the requested steps (`-sXXX`), strength (`-f0.XX`), and/or
+condition-free guidance (`-CXX.X`). If this is not working for you, a
+more extreme step is to provide the `--inpaint_replace 0.X` (`-r0.X`)
+option. This value ranges from 0.0 to 1.0. The higher it is the less
+attention the algorithm will pay to the data underneath the masked
+region. At high values this will enable you to replace colored regions
+entirely, but beware that the masked region mayl not blend in with the
+surrounding unmasked regions as well.
---
@@ -35,10 +166,10 @@ We are hoping to get rid of the need for this workaround in an upcoming release.
[GIMP](https://www.gimp.org/) is a popular Linux photoediting tool.
1. Open image in GIMP.
-2. Layer --> Transparency --> Add Alpha Channel
-3. Use lasoo tool to select region to mask
-4. Choose Select --> Float to create a floating selection
-5. Open the Layers toolbar (++ctrl+l++) and select "Floating Selection"
+2. Layer->Transparency->Add Alpha Channel
+3. Use lasso tool to select region to mask
+4. Choose Select -> Float to create a floating selection
+5. Open the Layers toolbar (^L) and select "Floating Selection"
6. Set opacity to a value between 0% and 99%
7. Export as PNG
8. In the export dialogue, Make sure the "Save colour values from
@@ -58,7 +189,7 @@ We are hoping to get rid of the need for this workaround in an upcoming release.
3. Because we'll be applying a mask over the area we want to preserve, you should now select the inverse by using the ++shift+ctrl+i++ shortcut, or right clicking and using the "Select Inverse" option.
-4. You'll now create a mask by selecting the image layer, and Masking the selection. Make sure that you don't delete any of the undrlying image, or your inpainting results will be dramatically impacted.
+4. You'll now create a mask by selecting the image layer, and Masking the selection. Make sure that you don't delete any of the underlying image, or your inpainting results will be dramatically impacted.
![step4](../assets/step4.png)
diff --git a/docs/features/OTHER.md b/docs/features/OTHER.md
index b05e3ea36e..e2e1c746fb 100644
--- a/docs/features/OTHER.md
+++ b/docs/features/OTHER.md
@@ -26,6 +26,12 @@ for each `invoke>` prompt as shown here:
invoke> "pond garden with lotus by claude monet" --seamless -s100 -n4
```
+By default this will tile on both the X and Y axes. However, you can also specify specific axes to tile on with `--seamless_axes`.
+Possible values are `x`, `y`, and `x,y`:
+```python
+invoke> "pond garden with lotus by claude monet" --seamless --seamless_axes=x -s100 -n4
+```
+
---
## **Shortcuts: Reusing Seeds**
@@ -69,6 +75,23 @@ combination of integers and floating point numbers, and they do not need to add
---
+## **Filename Format**
+
+The argument `--fnformat` allows to specify the filename of the
+ image. Supported wildcards are all arguments what can be set such as
+ `perlin`, `seed`, `threshold`, `height`, `width`, `gfpgan_strength`,
+ `sampler_name`, `steps`, `model`, `upscale`, `prompt`, `cfg_scale`,
+ `prefix`.
+
+The following prompt
+```bash
+dream> a red car --steps 25 -C 9.8 --perlin 0.1 --fnformat {prompt}_steps.{steps}_cfg.{cfg_scale}_perlin.{perlin}.png
+```
+
+generates a file with the name: `outputs/img-samples/a red car_steps.25_cfg.9.8_perlin.0.1.png`
+
+---
+
## **Thresholding and Perlin Noise Initialization Options**
Two new options are the thresholding (`--threshold`) and the perlin noise initialization (`--perlin`) options. Thresholding limits the range of the latent values during optimization, which helps combat oversaturation with higher CFG scale values. Perlin noise initialization starts with a percentage (a value ranging from 0 to 1) of perlin noise mixed into the initial noise. Both features allow for more variations and options in the course of generating images.
diff --git a/docs/features/POSTPROCESS.md b/docs/features/POSTPROCESS.md
index 70ec5498fc..29c63ffd14 100644
--- a/docs/features/POSTPROCESS.md
+++ b/docs/features/POSTPROCESS.md
@@ -70,7 +70,7 @@ If you do not explicitly specify an upscaling_strength, it will default to 0.75.
### Face Restoration
-`-G : `
+`-G : `
This prompt argument controls the strength of the face restoration that is being
applied. Similar to upscaling, values between `0.5 to 0.8` are recommended.
diff --git a/docs/index.md b/docs/index.md
index c9a19a18ce..25ab1bd48e 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -12,7 +12,7 @@ title: Home
-->