Skip to content

Commit 8d081de

Browse files
authored
Update FlowMatch docstrings to mention correct output classes (#10788)
update
1 parent a0c2299 commit 8d081de

File tree

2 files changed

+14
-12
lines changed

2 files changed

+14
-12
lines changed

src/diffusers/schedulers/scheduling_flow_match_euler_discrete.py

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -349,13 +349,14 @@ def step(
349349
generator (`torch.Generator`, *optional*):
350350
A random number generator.
351351
return_dict (`bool`):
352-
Whether or not to return a [`~schedulers.scheduling_euler_discrete.EulerDiscreteSchedulerOutput`] or
353-
tuple.
352+
Whether or not to return a
353+
[`~schedulers.scheduling_flow_match_euler_discrete.FlowMatchEulerDiscreteSchedulerOutput`] or tuple.
354354
355355
Returns:
356-
[`~schedulers.scheduling_euler_discrete.EulerDiscreteSchedulerOutput`] or `tuple`:
357-
If return_dict is `True`, [`~schedulers.scheduling_euler_discrete.EulerDiscreteSchedulerOutput`] is
358-
returned, otherwise a tuple is returned where the first element is the sample tensor.
356+
[`~schedulers.scheduling_flow_match_euler_discrete.FlowMatchEulerDiscreteSchedulerOutput`] or `tuple`:
357+
If return_dict is `True`,
358+
[`~schedulers.scheduling_flow_match_euler_discrete.FlowMatchEulerDiscreteSchedulerOutput`] is returned,
359+
otherwise a tuple is returned where the first element is the sample tensor.
359360
"""
360361

361362
if (
@@ -366,7 +367,7 @@ def step(
366367
raise ValueError(
367368
(
368369
"Passing integer indices (e.g. from `enumerate(timesteps)`) as timesteps to"
369-
" `EulerDiscreteScheduler.step()` is not supported. Make sure to pass"
370+
" `FlowMatchEulerDiscreteScheduler.step()` is not supported. Make sure to pass"
370371
" one of the `scheduler.timesteps` as a timestep."
371372
),
372373
)

src/diffusers/schedulers/scheduling_flow_match_heun_discrete.py

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -228,13 +228,14 @@ def step(
228228
generator (`torch.Generator`, *optional*):
229229
A random number generator.
230230
return_dict (`bool`):
231-
Whether or not to return a [`~schedulers.scheduling_Heun_discrete.HeunDiscreteSchedulerOutput`] or
232-
tuple.
231+
Whether or not to return a
232+
[`~schedulers.scheduling_flow_match_heun_discrete.FlowMatchHeunDiscreteSchedulerOutput`] tuple.
233233
234234
Returns:
235-
[`~schedulers.scheduling_Heun_discrete.HeunDiscreteSchedulerOutput`] or `tuple`:
236-
If return_dict is `True`, [`~schedulers.scheduling_Heun_discrete.HeunDiscreteSchedulerOutput`] is
237-
returned, otherwise a tuple is returned where the first element is the sample tensor.
235+
[`~schedulers.scheduling_flow_match_heun_discrete.FlowMatchHeunDiscreteSchedulerOutput`] or `tuple`:
236+
If return_dict is `True`,
237+
[`~schedulers.scheduling_flow_match_heun_discrete.FlowMatchHeunDiscreteSchedulerOutput`] is returned,
238+
otherwise a tuple is returned where the first element is the sample tensor.
238239
"""
239240

240241
if (
@@ -245,7 +246,7 @@ def step(
245246
raise ValueError(
246247
(
247248
"Passing integer indices (e.g. from `enumerate(timesteps)`) as timesteps to"
248-
" `HeunDiscreteScheduler.step()` is not supported. Make sure to pass"
249+
" `FlowMatchHeunDiscreteScheduler.step()` is not supported. Make sure to pass"
249250
" one of the `scheduler.timesteps` as a timestep."
250251
),
251252
)

0 commit comments

Comments
 (0)