Skip to content

Commit 1c687d6

Browse files
mauwiilstein
authored andcommitted
more updates to many docs, including:
- better readability in dark mode since color change - better looking changelog - fix images which where not loading - also center most of the images - fix some syntax errors like - headlines ending with a colon - codeblocks with wrong fences - codeblocks without shell - update conda prompts from ldm to invokeai - ....
1 parent 8ea07f3 commit 1c687d6

File tree

14 files changed

+253
-193
lines changed

14 files changed

+253
-193
lines changed

docs/CHANGELOG.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Changelog
44

55
# :octicons-log-16: **Changelog**
66

7-
- v2.0.0 (9 October 2022)
7+
## v2.0.0 <small>(9 October 2022)</small>
88

99
- `dream.py` script renamed `invoke.py`. A `dream.py` script wrapper remains
1010
for backward compatibility.
@@ -31,7 +31,7 @@ title: Changelog
3131
- Deprecated `--full_precision` / `-F`. Simply omit it and `invoke.py` will auto
3232
configure. To switch away from auto use the new flag like `--precision=float32`.
3333

34-
- v1.14 (11 September 2022)
34+
## v1.14 <small>(11 September 2022)</small>
3535

3636
- Memory optimizations for small-RAM cards. 512x512 now possible on 4 GB GPUs.
3737
- Full support for Apple hardware with M1 or M2 chips.
@@ -41,7 +41,7 @@ title: Changelog
4141
- Improved web server GUI.
4242
- Lots of code and documentation cleanups.
4343

44-
- v1.13 (3 September 2022
44+
## v1.13 <small>(3 September 2022)</small>
4545

4646
- Support image variations (see [VARIATIONS](features/VARIATIONS.md)
4747
([Kevin Gibbons](https://github.com/bakkot) and many contributors and reviewers)
@@ -61,7 +61,7 @@ title: Changelog
6161

6262
---
6363

64-
## v1.12 (28 August 2022)
64+
## v1.12 <small>(28 August 2022)</small>
6565

6666
- Improved file handling, including ability to read prompts from standard input.
6767
(kudos to [Yunsaki](https://github.com/yunsaki)
@@ -75,7 +75,7 @@ title: Changelog
7575

7676
---
7777

78-
## v1.11 (26 August 2022)
78+
## v1.11 <small>(26 August 2022)</small>
7979

8080
- NEW FEATURE: Support upscaling and face enhancement using the GFPGAN module. (kudos to [Oceanswave](https://github.com/Oceanswave)
8181
- 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.
@@ -88,13 +88,13 @@ title: Changelog
8888

8989
---
9090

91-
## v1.10 (25 August 2022)
91+
## v1.10 <small>(25 August 2022)</small>
9292

9393
- A barebones but fully functional interactive web server for online generation of txt2img and img2img.
9494

9595
---
9696

97-
## v1.09 (24 August 2022)
97+
## v1.09 <small>(24 August 2022)</small>
9898

9999
- A new -v option allows you to generate multiple variants of an initial image
100100
in img2img mode. (kudos to [Oceanswave](https://github.com/Oceanswave). [
@@ -104,7 +104,7 @@ title: Changelog
104104

105105
---
106106

107-
## v1.08 (24 August 2022)
107+
## v1.08 <small>(24 August 2022)</small>
108108

109109
- Escape single quotes on the invoke> command before trying to parse. This avoids
110110
parse errors.
@@ -115,22 +115,22 @@ title: Changelog
115115

116116
---
117117

118-
## v1.07 (23 August 2022)
118+
## v1.07 <small>(23 August 2022)</small>
119119

120120
- Image filenames will now never fill gaps in the sequence, but will be assigned the
121121
next higher name in the chosen directory. This ensures that the alphabetic and chronological
122122
sort orders are the same.
123123

124124
---
125125

126-
## v1.06 (23 August 2022)
126+
## v1.06 <small>(23 August 2022)</small>
127127

128128
- Added weighted prompt support contributed by [xraxra](https://github.com/xraxra)
129129
- Example of using weighted prompts to tweak a demonic figure contributed by [bmaltais](https://github.com/bmaltais)
130130

131131
---
132132

133-
## v1.05 (22 August 2022 - after the drop)
133+
## v1.05 <small>(22 August 2022 - after the drop)</small>
134134

135135
- Filenames now use the following formats:
136136
000010.95183149.png -- Two files produced by the same command (e.g. -n2),
@@ -148,22 +148,22 @@ title: Changelog
148148

149149
---
150150

151-
## v1.04 (22 August 2022 - after the drop)
151+
## v1.04 <small>(22 August 2022 - after the drop)</small>
152152

153153
- Updated README to reflect installation of the released weights.
154154
- Suppressed very noisy and inconsequential warning when loading the frozen CLIP
155155
tokenizer.
156156

157157
---
158158

159-
## v1.03 (22 August 2022)
159+
## v1.03 <small>(22 August 2022)</small>
160160

161161
- The original txt2img and img2img scripts from the CompViz repository have been moved into
162162
a subfolder named "orig_scripts", to reduce confusion.
163163

164164
---
165165

166-
## v1.02 (21 August 2022)
166+
## v1.02 <small>(21 August 2022)</small>
167167

168168
- A copy of the prompt and all of its switches and options is now stored in the corresponding
169169
image in a tEXt metadata field named "Dream". You can read the prompt using scripts/images2prompt.py,
@@ -172,7 +172,7 @@ title: Changelog
172172

173173
---
174174

175-
## v1.01 (21 August 2022)
175+
## v1.01 <small>(21 August 2022)</small>
176176

177177
- added k_lms sampling.
178178
**Please run "conda env update" to load the k_lms dependencies!!**

docs/features/CLI.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ The script is confirmed to work on Linux, Windows and Mac systems.
3434
currently rudimentary, but a much better replacement is on its way.
3535

3636
```bash
37-
(ldm) ~/stable-diffusion$ python3 ./scripts/invoke.py
37+
(invokeai) ~/stable-diffusion$ python3 ./scripts/invoke.py
3838
* Initializing, be patient...
3939
Loading model from models/ldm/text2img-large/model.ckpt
4040
(...more initialization messages...)
@@ -51,7 +51,7 @@ invoke> "there's a fly in my soup" -n6 -g
5151
invoke> q
5252

5353
# this shows how to retrieve the prompt stored in the saved image's metadata
54-
(ldm) ~/stable-diffusion$ python ./scripts/images2prompt.py outputs/img_samples/*.png
54+
(invokeai) ~/stable-diffusion$ python ./scripts/images2prompt.py outputs/img_samples/*.png
5555
00009.png: "ashley judd riding a camel" -s150 -S 416354203
5656
00010.png: "ashley judd riding a camel" -s150 -S 1362479620
5757
00011.png: "there's a fly in my soup" -n6 -g -S 2685670268

docs/features/INPAINTING.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -50,28 +50,28 @@ We are hoping to get rid of the need for this workaround in an upcoming release.
5050

5151
1. Open image in Photoshop
5252

53-
![step1](../assets/step1.png)
53+
<div align="center" markdown>![step1](../assets/step1.png)</div>
5454

5555
2. Use any of the selection tools (Marquee, Lasso, or Wand) to select the area you desire to inpaint.
5656

57-
![step2](../assets/step2.png)
57+
<div align="center" markdown>![step2](../assets/step2.png)</div>
5858

5959
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.
6060

6161
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.
6262

63-
![step4](../assets/step4.png)
63+
<div align="center" markdown>![step4](../assets/step4.png)</div>
6464

6565
5. Make sure to hide any background layers that are present. You should see the mask applied to your image layer, and the image on your canvas should display the checkered background.
6666

67-
![step5](../assets/step5.png)
67+
<div align="center" markdown>![step5](../assets/step5.png)</div>
6868

6969
6. Save the image as a transparent PNG by using `File`-->`Save a Copy` from the menu bar, or by using the keyboard shortcut ++alt+ctrl+s++
7070

71-
![step6](../assets/step6.png)
71+
<div align="center" markdown>![step6](../assets/step6.png)</div>
7272

7373
7. After following the inpainting instructions above (either through the CLI or the Web UI), marvel at your newfound ability to selectively invoke. Lookin' good!
7474

75-
![step7](../assets/step7.png)
75+
<div align="center" markdown>![step7](../assets/step7.png)</div>
7676

7777
8. In the export dialogue, Make sure the "Save colour values from transparent pixels" checkbox is selected.

docs/features/OTHER.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,13 @@ title: Others
66

77
## **Google Colab**
88

9-
Stable Diffusion AI Notebook: [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/lstein/stable-diffusion/blob/main/notebooks/Stable_Diffusion_AI_Notebook.ipynb)
9+
[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg){ align="right" }](https://colab.research.google.com/github/lstein/stable-diffusion/blob/main/notebooks/Stable_Diffusion_AI_Notebook.ipynb)
1010

1111
Open and follow instructions to use an isolated environment running Dream.
1212

13-
Output Example: ![Colab Notebook](../assets/colab_notebook.png)
13+
Output Example:
14+
15+
![Colab Notebook](../assets/colab_notebook.png)
1416

1517
---
1618

@@ -29,12 +31,12 @@ invoke> "pond garden with lotus by claude monet" --seamless -s100 -n4
2931
## **Shortcuts: Reusing Seeds**
3032

3133
Since it is so common to reuse seeds while refining a prompt, there is now a shortcut as of version
32-
1.11. Provide a `**-S**` (or `**--seed**`) switch of `-1` to use the seed of the most recent image
33-
generated. If you produced multiple images with the `**-n**` switch, then you can go back further
34-
using -2, -3, etc. up to the first image generated by the previous command. Sorry, but you can't go
34+
1.11. Provide a `-S` (or `--seed`) switch of `-1` to use the seed of the most recent image
35+
generated. If you produced multiple images with the `-n` switch, then you can go back further
36+
using `-2`, `-3`, etc. up to the first image generated by the previous command. Sorry, but you can't go
3537
back further than one command.
3638

37-
Here's an example of using this to do a quick refinement. It also illustrates using the new `**-G**`
39+
Here's an example of using this to do a quick refinement. It also illustrates using the new `-G`
3840
switch to turn on upscaling and face enhancement (see previous section):
3941

4042
```bash
@@ -54,7 +56,7 @@ outputs/img-samples/000040.3498014304.png: "a cute child playing hopscotch" -G1.
5456
## **Weighted Prompts**
5557

5658
You may weight different sections of the prompt to tell the sampler to attach different levels of
57-
priority to them, by adding `:(number)` to the end of the section you wish to up- or downweight. For
59+
priority to them, by adding `:<percent>` to the end of the section you wish to up- or downweight. For
5860
example consider this prompt:
5961

6062
```bash
@@ -122,7 +124,7 @@ internet. In the following runs, it will load up the cached versions of the requ
122124
`.cache` directory of the system.
123125

124126
```bash
125-
(ldm) ~/stable-diffusion$ python3 ./scripts/preload_models.py
127+
(invokeai) ~/stable-diffusion$ python3 ./scripts/preload_models.py
126128
preloading bert tokenizer...
127129
Downloading: 100%|██████████████████████████████████| 28.0/28.0 [00:00<00:00, 49.3kB/s]
128130
Downloading: 100%|██████████████████████████████████| 226k/226k [00:00<00:00, 2.79MB/s]

docs/features/OUTPAINTING.md

Lines changed: 21 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -25,14 +25,16 @@ implementations.
2525

2626
Consider this image:
2727

28+
<div align="center" markdown>
2829
![curly_woman](../assets/outpainting/curly.png)
30+
</div>
2931

3032
Pretty nice, but it's annoying that the top of her head is cut
3133
off. She's also a bit off center. Let's fix that!
3234

33-
~~~~
35+
```bash
3436
invoke> !fix images/curly.png --outcrop top 64 right 64
35-
~~~~
37+
```
3638

3739
This is saying to apply the `outcrop` extension by extending the top
3840
of the image by 64 pixels, and the right of the image by the same
@@ -42,7 +44,9 @@ specify any number of pixels to extend. You can also abbreviate
4244

4345
The result looks like this:
4446

47+
<div align="center" markdown>
4548
![curly_woman_outcrop](../assets/outpainting/curly-outcrop.png)
49+
</div>
4650

4751
The new image is actually slightly larger than the original (576x576,
4852
because 64 pixels were added to the top and right sides.)
@@ -66,33 +70,36 @@ The `outpaint` extension does the same thing, but with subtle
6670
differences. Starting with the same image, here is how we would add an
6771
additional 64 pixels to the top of the image:
6872

69-
~~~
73+
```bash
7074
invoke> !fix images/curly.png --out_direction top 64
71-
~~~
75+
```
7276

7377
(you can abbreviate `--out_direction` as `-D`.
7478

7579
The result is shown here:
7680

81+
<div align="center" markdown>
7782
![curly_woman_outpaint](../assets/outpainting/curly-outpaint.png)
83+
</div>
7884

7985
Although the effect is similar, there are significant differences from
8086
outcropping:
8187

82-
1. You can only specify one direction to extend at a time.
83-
2. The image is **not** resized. Instead, the image is shifted by the specified
88+
- You can only specify one direction to extend at a time.
89+
- The image is **not** resized. Instead, the image is shifted by the specified
8490
number of pixels. If you look carefully, you'll see that less of the lady's
8591
torso is visible in the image.
86-
3. Because the image dimensions remain the same, there's no rounding
92+
- Because the image dimensions remain the same, there's no rounding
8793
to multiples of 64.
88-
4. Attempting to outpaint larger areas will frequently give rise to ugly
94+
- Attempting to outpaint larger areas will frequently give rise to ugly
8995
ghosting effects.
90-
5. For best results, try increasing the step number.
91-
6. If you don't specify a pixel value in -D, it will default to half
96+
- For best results, try increasing the step number.
97+
- If you don't specify a pixel value in `-D`, it will default to half
9298
of the whole image, which is likely not what you want.
9399

94-
Neither `outpaint` nor `outcrop` are perfect, but we continue to tune
95-
and improve them. If one doesn't work, try the other. You may also
96-
wish to experiment with other `img2img` arguments, such as `-C`, `-f`
97-
and `-s`.
100+
!!! tip
98101

102+
Neither `outpaint` nor `outcrop` are perfect, but we continue to tune
103+
and improve them. If one doesn't work, try the other. You may also
104+
wish to experiment with other `img2img` arguments, such as `-C`, `-f`
105+
and `-s`.

docs/features/POSTPROCESS.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -34,13 +34,13 @@ work. These are loaded when you run `scripts/preload_models.py`. If
3434
GFPAN is failing with an error, please run the following from the
3535
InvokeAI directory:
3636

37-
~~~~
37+
```bash
3838
python scripts/preload_models.py
39-
~~~~
39+
```
4040

4141
If you do not run this script in advance, the GFPGAN module will attempt
4242
to download the models files the first time you try to perform facial
43-
reconstruction.
43+
reconstruction.
4444

4545
Alternatively, if you have GFPGAN installed elsewhere, or if you are
4646
using an earlier version of this package which asked you to install
@@ -89,13 +89,13 @@ too.
8989
### Example Usage
9090

9191
```bash
92-
invoke> superman dancing with a panda bear -U 2 0.6 -G 0.4
92+
invoke> "superman dancing with a panda bear" -U 2 0.6 -G 0.4
9393
```
9494

9595
This also works with img2img:
9696

9797
```bash
98-
invoke> a man wearing a pineapple hat -I path/to/your/file.png -U 2 0.5 -G 0.6
98+
invoke> "a man wearing a pineapple hat" -I path/to/your/file.png -U 2 0.5 -G 0.6
9999
```
100100

101101
!!! note
@@ -129,14 +129,14 @@ You can use `-ft` prompt argument to swap between CodeFormer and the
129129
default GFPGAN. The above mentioned `-G` prompt argument will allow
130130
you to control the strength of the restoration effect.
131131

132-
### Usage:
132+
### Usage
133133

134134
The following command will perform face restoration with CodeFormer instead of
135135
the default gfpgan.
136136

137137
`<prompt> -G 0.8 -ft codeformer`
138138

139-
### Other Options:
139+
### Other Options
140140

141141
- `-cf` - cf or CodeFormer Fidelity takes values between `0` and `1`. 0 produces
142142
high quality results but low accuracy and 1 produces lower quality results but
@@ -162,15 +162,15 @@ previously-generated file. Just use the syntax `!fix path/to/file.png
162162
2X for a file named `./outputs/img-samples/000044.2945021133.png`,
163163
just run:
164164

165-
```
165+
```bash
166166
invoke> !fix ./outputs/img-samples/000044.2945021133.png -G 0.8 -U 2
167167
```
168168

169169
A new file named `000044.2945021133.fixed.png` will be created in the output
170170
directory. Note that the `!fix` command does not replace the original file,
171171
unlike the behavior at generate time.
172172

173-
### Disabling:
173+
### Disabling
174174

175175
If, for some reason, you do not wish to load the GFPGAN and/or ESRGAN libraries,
176176
you can disable them on the invoke.py command line with the `--no_restore` and

0 commit comments

Comments
 (0)