Skip to content

Commit 5fd964b

Browse files
authored
Added documentation page
1 parent 7b26949 commit 5fd964b

File tree

1 file changed

+59
-0
lines changed

1 file changed

+59
-0
lines changed

DOCUMENTATION.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
## How to use DiffusionBee
2+
3+
This documentation is written for version 1.1.0. Parts of it may be unapplicable for other versions.
4+
5+
### Installation
6+
7+
On first launch, DiffusionBee will download and install additional data for image generation.
8+
9+
## Generating images
10+
11+
Depending on settings and available computing power it may take a few seconds to a few minutes to generate an image. Image generation may be aborted by pressing the stop button. Use the "save image" link to save the image to a location of your choice.
12+
13+
Clicking on an image opens a separate window displaying the image in full size.
14+
15+
### Text to image
16+
17+
To create an image, simply enter a prompt and press _generate_.
18+
19+
* The **Prompt ideas** button opens a web page where you can browse a gallery for finding useful prompts.
20+
* The **Styles** button provides a palette of often-used terms to add to the prompt.
21+
* The **Advanced options** buttons gives the following options:
22+
* Num images: The number of images to generate.
23+
* Image height/width: Sets the dimensions of the image. Note that Stable Diffusion is trained on 512 x 512 (the default setting). Other dimensions may give less good result and take more time.
24+
* Steps: This corresponds to how many steps are used to improve the image quality. Setting to a low number gives faster image generation, and may be useful while exploring different prompts.
25+
* Batch size: This tells DiffusionBee to generate multiple images at a time. New batches of images will be created until "num images" have been created. (Just increasing _num images_ is usually a better option.)
26+
* Guidance scale: This kind of corresponds to how closely Stable Diffusion should stick to the prompt. Higher value means more strict interpretation.
27+
* Seed: A number between 0 and 4,294,967,295 that is used as starting point for the image generation. If the same seed is used with the same prompt and the same settings (except *steps*, which may vary), the same image will be generated. If left empty, a random seed will be used.
28+
29+
### Image to image
30+
31+
Click on the left pane to upload a sketch starting image (only png supported). Add a prompt description of the desired output and press _generate_. The generated image will be 512 x 512 pixels.
32+
33+
* The **Options** buttons gives the following options:
34+
* Input strength: This tells DiffusionBee how closely to stick to the sketch input image. For rough sketches you normally want a low value.
35+
* Num images: The number of images to generate.
36+
* Steps: This corresponds to how many steps are used to build the image. Setting to a low number gives faster image generation, and may be useful while exploring different prompts.
37+
* Seed: A number between 0 and 4,294,967,295 that is used as starting point for the image generation. If the same seed is used with the same image, the same prompt and the same settings (except *steps*, which may vary), the same image will be generated. If left empty, a random seed will be used.
38+
39+
## History
40+
41+
The **History** tab show previously generated images along with prompts and settings (including seed).
42+
43+
## Extra tips
44+
45+
* For prompt ideas and help, check out:
46+
- [lexica.art](https://lexica.art/)
47+
- [arthub.ai](https://arthub.ai/)
48+
- `Prompt Engineering` section at [AssemblyAI](https://www.assemblyai.com/blog/how-to-run-stable-diffusion-locally-to-generate-images/)
49+
* Image generation requires a substantial amount of system memory. Close other applications for a faster generation.
50+
* You can save time while tuning your prompts by lowering the *steps* setting, then turning it back up once you found a good prompt.
51+
* When tuning prompts, make sure that you enter a seed to make it possible to recreate images. If you generate more than one image per seed (via either the Num Images or Batch setting) there will not be a way to tie any of the images generated after the first one to the same seed. For example, if I have Num Images set to 3 and Seed set to 1000, the first of my three generated images will correspond to the seed of 1000, but I won't know the seed for the other two images.
52+
* When _num images_ is set to more than 1, `1234` is added to the seed for each image following the first one. (This can be used to recreate number 4 in a string of images without having to recreate all the previous ones.)
53+
* All created images are stored at `~/.diffusionbee/images/` in your file system. There is no interface in DiffusionBee for deleting images, but they can be deleted manually from this hidden directory.
54+
* The model is stored at `~/.diffusionbee/downloads`. If you already have the model available and don't want to re-download it, move, copy or symlink it to that directory.
55+
* The _Show logs_ menu option shows logs that are mostly useful for developers or for tracking errors. You exit the log by clicking one of the tabs.
56+
57+
## Join the discussion
58+
59+
Join the DiffusionBee discord at https://discord.gg/t6rC5RaJQn

0 commit comments

Comments
 (0)