Skip to content
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

Merged
merged 5 commits into from
Nov 1, 2023
Merged

[Docs] Fix typos, improve, update at Get Started page #5587

merged 5 commits into from
Nov 1, 2023

Conversation

tolgacangoz
Copy link
Contributor

@tolgacangoz tolgacangoz commented Oct 30, 2023

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

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.

@HuggingFaceDocBuilderDev
Copy link

HuggingFaceDocBuilderDev commented Oct 30, 2023

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)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
>>> scheduler = DDPMScheduler.from_pretrained(repo_id)
>>> scheduler = DDPMScheduler.from_config(repo_id, subfolder="scheduler")

Copy link
Contributor Author

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!
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can keep this

Copy link
Collaborator

@DN6 DN6 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍🏽 Nicely done!

@DN6
Copy link
Collaborator

DN6 commented Oct 31, 2023

cc'ing: @stevhliu to also take a look

Copy link
Member

@stevhliu stevhliu left a 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! 👍

docs/README.md Outdated Show resolved Hide resolved
docs/README.md Outdated Show resolved Hide resolved
@@ -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):
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
After activating your virtual environment, with `conda` (maintained by the community):
After activating your virtual environment, you can also install with `conda`:

Copy link
Contributor Author

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?

Copy link
Member

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 :)

docs/source/en/quicktour.md Outdated Show resolved Hide resolved
docs/source/en/quicktour.md Outdated Show resolved Hide resolved
tolgacangoz and others added 3 commits November 1, 2023 10:04
Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
@patrickvonplaten patrickvonplaten merged commit b81c69e into huggingface:main Nov 1, 2023
11 checks passed
kashif pushed a commit to kashif/diffusers that referenced this pull request Nov 11, 2023
* Fix typos, improve, update

* Update _toctree.yml

* Update docs/README.md

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>

* Update docs/README.md

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>

* Apply Grammarly fixes

---------

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
@tolgacangoz tolgacangoz deleted the fix-typos-6 branch November 30, 2023 07:23
AmericanPresidentJimmyCarter pushed a commit to AmericanPresidentJimmyCarter/diffusers that referenced this pull request Apr 26, 2024
* Fix typos, improve, update

* Update _toctree.yml

* Update docs/README.md

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>

* Update docs/README.md

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>

* Apply Grammarly fixes

---------

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants