Skip to content

Commit a7508a7

Browse files
sayakpaulstevhliu
andauthored
add: pushtohubmixin to pipelines and schedulers docs overview. (huggingface#4607)
* add: pushtohubmixin to pipelines and schedulers docs overview. * Apply suggestions from code review Co-authored-by: Steven Liu <[email protected]> --------- Co-authored-by: Steven Liu <[email protected]>
1 parent aaef41b commit a7508a7

File tree

3 files changed

+11
-3
lines changed

3 files changed

+11
-3
lines changed

docs/source/en/api/pipelines/overview.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,3 +34,7 @@ Pipelines do not offer any training functionality. You'll notice PyTorch's autog
3434
## FlaxDiffusionPipeline
3535

3636
[[autodoc]] pipelines.pipeline_flax_utils.FlaxDiffusionPipeline
37+
38+
## PushToHubMixin
39+
40+
[[autodoc]] utils.PushToHubMixin

docs/source/en/api/schedulers/overview.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,4 +57,8 @@ All schedulers are built from the base [`SchedulerMixin`] class which implements
5757

5858
[`KarrasDiffusionSchedulers`] are a broad generalization of schedulers in 🤗 Diffusers. The schedulers in this class are distinguished at a high level by their noise sampling strategy, the type of network and scaling, the training strategy, and how the loss is weighed.
5959

60-
The different schedulers in this class, depending on the ordinary differential equations (ODE) solver type, fall into the above taxonomy and provide a good abstraction for the design of the main schedulers implemented in 🤗 Diffusers. The schedulers in this class are given [here](https://github.com/huggingface/diffusers/blob/a69754bb879ed55b9b6dc9dd0b3cf4fa4124c765/src/diffusers/schedulers/scheduling_utils.py#L32).
60+
The different schedulers in this class, depending on the ordinary differential equations (ODE) solver type, fall into the above taxonomy and provide a good abstraction for the design of the main schedulers implemented in 🤗 Diffusers. The schedulers in this class are given [here](https://github.com/huggingface/diffusers/blob/a69754bb879ed55b9b6dc9dd0b3cf4fa4124c765/src/diffusers/schedulers/scheduling_utils.py#L32).
61+
62+
## PushToHubMixin
63+
64+
[[autodoc]] utils.PushToHubMixin

src/diffusers/utils/hub_utils.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -372,7 +372,7 @@ def _get_model_file(
372372

373373
class PushToHubMixin:
374374
"""
375-
A Mixin containing the functionality to push a model/scheduler to the Hugging Face Hub.
375+
A Mixin to push a model, scheduler, or pipeline to the Hugging Face Hub.
376376
"""
377377

378378
def _upload_folder(
@@ -440,7 +440,7 @@ def push_to_hub(
440440
# Push the `unet` to your namespace with the name "my-finetuned-unet".
441441
unet.push_to_hub("my-finetuned-unet")
442442
443-
# Push the {object} to an organization with the name "my-finetuned-unet".
443+
# Push the `unet` to an organization with the name "my-finetuned-unet".
444444
unet.push_to_hub("your-org/my-finetuned-unet")
445445
```
446446
"""

0 commit comments

Comments
 (0)