-
Notifications
You must be signed in to change notification settings - Fork 5.6k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Docs] Fix typos, improve, update at Get Started page #5587
Conversation
The documentation is not available anymore as the PR was closed or merged. |
@@ -215,40 +215,46 @@ For the quicktour, you'll instantiate the [`DDPMScheduler`] with it's [`~diffuse | |||
```py | |||
>>> from diffusers import DDPMScheduler | |||
|
|||
>>> scheduler = DDPMScheduler.from_config(repo_id) | |||
>>> scheduler = DDPMScheduler.from_pretrained(repo_id) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
>>> scheduler = DDPMScheduler.from_pretrained(repo_id) | |
>>> scheduler = DDPMScheduler.from_config(repo_id, subfolder="scheduler") |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It still says "/usr/local/lib/python3.10/dist-packages/diffusers/configuration_utils.py:239: FutureWarning: It is deprecated to pass a pretrained model name or path to from_config
.If you were trying to load a scheduler, please use <class 'diffusers.schedulers.scheduling_ddpm.DDPMScheduler'>.from_pretrained(...) instead. Otherwise, please make sure to pass a configuration dictionary instead. This functionality will be removed in v1.0.0.
deprecate("config-passed-as-path", "1.0.0", deprecation_message, standard_warn=False)".
"trained_betas": null, | ||
"variance_type": "fixed_small" | ||
} | ||
``` | ||
|
||
<Tip> | ||
|
||
💡 Notice how the scheduler is instantiated from a configuration. Unlike a model, a scheduler does not have trainable weights and is parameter-free! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We can keep this
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM 👍🏽 Nicely done!
cc'ing: @stevhliu to also take a look |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the fixes! 👍
@@ -50,6 +50,14 @@ pip install diffusers["flax"] transformers | |||
</jax> | |||
</frameworkcontent> | |||
|
|||
## Install with conda | |||
|
|||
After activating your virtual environment, with `conda` (maintained by the community): |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
After activating your virtual environment, with `conda` (maintained by the community): | |
After activating your virtual environment, you can also install with `conda`: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Now, is conda maintained officially rather than by the community?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good question, I don't think we officially maintain this but @patrickvonplaten or @sayakpaul would know more.
If it is community maintained, then no need to make any changes :)
Co-authored-by: Steven Liu <[email protected]>
Co-authored-by: Steven Liu <[email protected]>
* Fix typos, improve, update * Update _toctree.yml * Update docs/README.md Co-authored-by: Steven Liu <[email protected]> * Update docs/README.md Co-authored-by: Steven Liu <[email protected]> * Apply Grammarly fixes --------- Co-authored-by: Steven Liu <[email protected]>
* Fix typos, improve, update * Update _toctree.yml * Update docs/README.md Co-authored-by: Steven Liu <[email protected]> * Update docs/README.md Co-authored-by: Steven Liu <[email protected]> * Apply Grammarly fixes --------- Co-authored-by: Steven Liu <[email protected]>
What does this PR do?
Hi! Thank you for this awesome library!
I am new to open source. Firstly, I am reading the documentation. Secondly, I will read the codebase. Thirdly, I plan to make documentation and code contributions.
I would be grateful for your feedback. @stevhliu @yiyixuxu @patrickvonplaten
Before submitting
documentation guidelines, and
here are tips on formatting docstrings.
Who can review?
Anyone in the community is free to review the PR once the tests have passed. Feel free to tag
members/contributors who may be interested in your PR.