mskrt commited on
Commit
15c2741
verified
1 Parent(s): f3eae8e

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +23 -8
README.md CHANGED
@@ -17,6 +17,21 @@ This pipeline shows how to superimpose different text prompts from [Stable Diffu
17
  <img src="https://huggingface.co/superdiff/superdiff-sd-v1-4/resolve/main/superdiff_small.gif" alt="drawing" style="width:500px;">
18
  </p>
19
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
20
 
21
  ## Example usage
22
 
@@ -33,14 +48,14 @@ image.save("superdiff_output.png")
33
 
34
  Arguments that can be set by user in `pipeline()`:
35
 
36
- - `prompt_1`: text prompt describing first concept to superimpose (e.g. "a flamingo")
37
- - `prompt_2`: text prompt describing second concept to superimpose (e.g. "a candy cane")
38
- - `seed`: seed for random noise generator for reproducibility; for non-deterministic outputs, do not provide value
39
- - `num_inference_steps`: number of denoising steps (we recommend 1000!)
40
- - `batch_size`: batch size
41
- - `lift`: bias value that favours generation towards one prompt over the other
42
- - `guidance_scale`: scale for classifier-free guidance
43
- - `height`, `width`: height and width of generated images
44
 
45
  To replicate images from Section 4.2 of the paper, you can use the following:
46
 
 
17
  <img src="https://huggingface.co/superdiff/superdiff-sd-v1-4/resolve/main/superdiff_small.gif" alt="drawing" style="width:500px;">
18
  </p>
19
 
20
+ ## Requirements
21
+
22
+ This pipeline can be run with the following packages & versions:
23
+ - PyTorch 2.5.1
24
+ - Diffusers 0.32.1
25
+ - Accelerate 1.2.1
26
+ - Transformers 4.47.1
27
+
28
+ You can install these with:
29
+
30
+ ```
31
+ pip install torch
32
+ pip install diffusers accelerate transformers
33
+ ```
34
+
35
 
36
  ## Example usage
37
 
 
48
 
49
  Arguments that can be set by user in `pipeline()`:
50
 
51
+ - `prompt_1` [required]: text prompt describing first concept to superimpose (e.g. "a flamingo")
52
+ - `prompt_2`[required]: text prompt describing second concept to superimpose (e.g. "a candy cane")
53
+ - `seed`[optional: default=None]: seed for random noise generator for reproducibility; for non-deterministic outputs, set to `None`
54
+ - `num_inference_steps`[optional: default=1000]: number of denoising steps (we recommend 1000!)
55
+ - `batch_size` [optional: default=1]: batch size
56
+ - `lift` [optional: default=0.0]: bias value that favours generation towards one prompt over the other
57
+ - `guidance_scale` [optional: default=7.5]: scale for classifier-free guidance
58
+ - `height`, `width` [optional: default=512]: height and width of generated images
59
 
60
  To replicate images from Section 4.2 of the paper, you can use the following:
61