Skip to content

Commit c502f1c

Browse files
[Better scheduler docs] Improve usage examples of schedulers
1 parent c1fad36 commit c502f1c

File tree

6 files changed

+11
-19
lines changed

6 files changed

+11
-19
lines changed

README.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -131,11 +131,7 @@ it before the pipeline and pass it to `from_pretrained`.
131131
```python
132132
from diffusers import LMSDiscreteScheduler
133133

134-
lms = LMSDiscreteScheduler(
135-
beta_start=0.00085,
136-
beta_end=0.012,
137-
beta_schedule="scaled_linear"
138-
)
134+
lms = LMSDiscreteScheduler.from_config("CompVis/stable-diffusion-v1-4", subfolder="scheduler")
139135

140136
pipe = StableDiffusionPipeline.from_pretrained(
141137
"CompVis/stable-diffusion-v1-4",

docs/source/quicktour.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ you could use it as follows:
122122
```python
123123
>>> from diffusers import LMSDiscreteScheduler
124124

125-
>>> scheduler = LMSDiscreteScheduler(beta_start=0.00085, beta_end=0.012, beta_schedule="scaled_linear")
125+
>>> scheduler = LMSDiscreteScheduler.from_config("CompVis/stable-diffusion-v1-4", subfolder="scheduler")
126126

127127
>>> generator = StableDiffusionPipeline.from_pretrained(
128128
... "CompVis/stable-diffusion-v1-4", scheduler=scheduler, use_auth_token=AUTH_TOKEN

src/diffusers/pipeline_flax_utils.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -271,7 +271,7 @@ def from_pretrained(cls, pretrained_model_name_or_path: Optional[Union[str, os.P
271271
>>> # Download pipeline, but overwrite scheduler
272272
>>> from diffusers import LMSDiscreteScheduler
273273
274-
>>> scheduler = LMSDiscreteScheduler(beta_start=0.00085, beta_end=0.012, beta_schedule="scaled_linear")
274+
>>> scheduler = LMSDiscreteScheduler.from_config("CompVis/stable-diffusion-v1-4", subfolder="scheduler")
275275
>>> pipeline = FlaxDiffusionPipeline.from_pretrained("CompVis/stable-diffusion-v1-4", scheduler=scheduler)
276276
```
277277
"""

src/diffusers/pipeline_utils.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -343,7 +343,7 @@ def from_pretrained(cls, pretrained_model_name_or_path: Optional[Union[str, os.P
343343
>>> # Download pipeline, but overwrite scheduler
344344
>>> from diffusers import LMSDiscreteScheduler
345345
346-
>>> scheduler = LMSDiscreteScheduler(beta_start=0.00085, beta_end=0.012, beta_schedule="scaled_linear")
346+
>>> scheduler = LMSDiscreteScheduler.from_config("CompVis/stable-diffusion-v1-4", subfolder="scheduler")
347347
>>> pipeline = DiffusionPipeline.from_pretrained("CompVis/stable-diffusion-v1-4", scheduler=scheduler)
348348
```
349349
"""

src/diffusers/pipelines/stable_diffusion/README.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ image.save("astronaut_rides_horse.png")
7272
# make sure you're logged in with `huggingface-cli login`
7373
from diffusers import StableDiffusionPipeline, DDIMScheduler
7474

75-
scheduler = DDIMScheduler(beta_start=0.00085, beta_end=0.012, beta_schedule="scaled_linear", clip_sample=False, set_alpha_to_one=False)
75+
scheduler = DDIMScheduler.from_config("CompVis/stable-diffusion-v1-4", subfolder="scheduler")
7676

7777
pipe = StableDiffusionPipeline.from_pretrained(
7878
"CompVis/stable-diffusion-v1-4",
@@ -91,11 +91,7 @@ image.save("astronaut_rides_horse.png")
9191
# make sure you're logged in with `huggingface-cli login`
9292
from diffusers import StableDiffusionPipeline, LMSDiscreteScheduler
9393

94-
lms = LMSDiscreteScheduler(
95-
beta_start=0.00085,
96-
beta_end=0.012,
97-
beta_schedule="scaled_linear"
98-
)
94+
lms = LMSDiscreteScheduler.from_config("CompVis/stable-diffusion-v1-4", subfolder="scheduler")
9995

10096
pipe = StableDiffusionPipeline.from_pretrained(
10197
"CompVis/stable-diffusion-v1-4",

tests/test_pipelines.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -512,7 +512,7 @@ def test_stable_diffusion_no_safety_checker(self):
512512
def test_stable_diffusion_k_lms(self):
513513
device = "cpu" # ensure determinism for the device-dependent torch.Generator
514514
unet = self.dummy_cond_unet
515-
scheduler = LMSDiscreteScheduler(beta_start=0.00085, beta_end=0.012, beta_schedule="scaled_linear")
515+
scheduler = LMSDiscreteScheduler.from_config("CompVis/stable-diffusion-v1-4", subfolder="scheduler")
516516
vae = self.dummy_vae
517517
bert = self.dummy_text_encoder
518518
tokenizer = CLIPTokenizer.from_pretrained("hf-internal-testing/tiny-random-clip")
@@ -557,7 +557,7 @@ def test_stable_diffusion_k_lms(self):
557557
def test_stable_diffusion_attention_chunk(self):
558558
device = "cpu" # ensure determinism for the device-dependent torch.Generator
559559
unet = self.dummy_cond_unet
560-
scheduler = LMSDiscreteScheduler(beta_start=0.00085, beta_end=0.012, beta_schedule="scaled_linear")
560+
scheduler = LMSDiscreteScheduler.from_config("CompVis/stable-diffusion-v1-4", subfolder="scheduler")
561561
vae = self.dummy_vae
562562
bert = self.dummy_text_encoder
563563
tokenizer = CLIPTokenizer.from_pretrained("hf-internal-testing/tiny-random-clip")
@@ -842,7 +842,7 @@ def test_stable_diffusion_img2img_multiple_init_images(self):
842842
def test_stable_diffusion_img2img_k_lms(self):
843843
device = "cpu" # ensure determinism for the device-dependent torch.Generator
844844
unet = self.dummy_cond_unet
845-
scheduler = LMSDiscreteScheduler(beta_start=0.00085, beta_end=0.012, beta_schedule="scaled_linear")
845+
scheduler = LMSDiscreteScheduler.from_config("CompVis/stable-diffusion-v1-4", subfolder="scheduler")
846846

847847
vae = self.dummy_vae
848848
bert = self.dummy_text_encoder
@@ -1943,7 +1943,7 @@ def test_stable_diffusion_img2img_pipeline_k_lms(self):
19431943
init_image = init_image.resize((768, 512))
19441944
expected_image = np.array(expected_image, dtype=np.float32) / 255.0
19451945

1946-
lms = LMSDiscreteScheduler(beta_start=0.00085, beta_end=0.012, beta_schedule="scaled_linear")
1946+
lms = LMSDiscreteScheduler.from_config("CompVis/stable-diffusion-v1-4", subfolder="scheduler")
19471947

19481948
model_id = "CompVis/stable-diffusion-v1-4"
19491949
pipe = StableDiffusionImg2ImgPipeline.from_pretrained(
@@ -2032,7 +2032,7 @@ def test_stable_diffusion_inpaint_pipeline_k_lms(self):
20322032
)
20332033
expected_image = np.array(expected_image, dtype=np.float32) / 255.0
20342034

2035-
lms = LMSDiscreteScheduler(beta_start=0.00085, beta_end=0.012, beta_schedule="scaled_linear")
2035+
lms = LMSDiscreteScheduler.from_config("CompVis/stable-diffusion-v1-4", subfolder="scheduler")
20362036

20372037
model_id = "CompVis/stable-diffusion-v1-4"
20382038
pipe = StableDiffusionInpaintPipeline.from_pretrained(

0 commit comments

Comments
 (0)