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

tolgacangoz · 2023-10-30T17:16:18Z

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

This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case).
Did you read the contributor guideline?
Did you read our philosophy doc (important for complex PRs)?
Was this discussed/approved via a GitHub issue or the forum? Please add a link to it if that's the case.
Did you make sure to update the documentation with your changes? Here are the
documentation guidelines, and
here are tips on formatting docstrings.
Did you write any new necessary tests?

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 · 2023-10-30T18:13:14Z

The documentation is not available anymore as the PR was closed or merged.

DN6 · 2023-10-31T05:36:35Z

docs/source/en/quicktour.md

 >>> from diffusers import DDPMScheduler

->>> scheduler = DDPMScheduler.from_config(repo_id)
+>>> scheduler = DDPMScheduler.from_pretrained(repo_id)


Suggested change

>>> scheduler = DDPMScheduler.from_pretrained(repo_id)

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

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)".

DN6 · 2023-10-31T05:37:22Z

docs/source/en/quicktour.md


 <Tip>

-💡 Notice how the scheduler is instantiated from a configuration. Unlike a model, a scheduler does not have trainable weights and is parameter-free!


We can keep this

DN6

LGTM 👍🏽 Nicely done!

DN6 · 2023-10-31T05:39:21Z

cc'ing: @stevhliu to also take a look

stevhliu

Thanks for the fixes! 👍

docs/README.md

stevhliu · 2023-10-31T16:20:38Z

docs/source/en/installation.md


+## Install with conda
+
+After activating your virtual environment, with `conda` (maintained by the community):


Suggested change

After activating your virtual environment, with `conda` (maintained by the community):

After activating your virtual environment, you can also install with `conda`:

Now, is conda maintained officially rather than by the community?

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

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

* 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 and others added 2 commits October 30, 2023 19:45

Fix typos, improve, update

535505a

Update _toctree.yml

045d80d

DN6 reviewed Oct 31, 2023

View reviewed changes

DN6 approved these changes Oct 31, 2023

View reviewed changes

stevhliu approved these changes Oct 31, 2023

View reviewed changes

tolgacangoz and others added 3 commits November 1, 2023 10:04

Update docs/README.md

ff3ab3d

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

Update docs/README.md

569fdf4

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

Apply Grammarly fixes

16e3867

patrickvonplaten merged commit b81c69e into huggingface:main Nov 1, 2023

tolgacangoz deleted the fix-typos-6 branch November 30, 2023 07:23

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


		<Tip>

		💡 Notice how the scheduler is instantiated from a configuration. Unlike a model, a scheduler does not have trainable weights and is parameter-free!


		## Install with conda

		After activating your virtual environment, with `conda` (maintained by the community):

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

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

Uh oh!

Conversation

tolgacangoz commented Oct 30, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this PR do?

Before submitting

Who can review?

Uh oh!

HuggingFaceDocBuilderDev commented Oct 30, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

DN6 Oct 31, 2023

Choose a reason for hiding this comment

Uh oh!

tolgacangoz Nov 1, 2023

Choose a reason for hiding this comment

Uh oh!

DN6 Oct 31, 2023

Choose a reason for hiding this comment

Uh oh!

DN6 left a comment

Choose a reason for hiding this comment

Uh oh!

DN6 commented Oct 31, 2023

Uh oh!

stevhliu left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

stevhliu Oct 31, 2023

Choose a reason for hiding this comment

Uh oh!

tolgacangoz Nov 1, 2023

Choose a reason for hiding this comment

Uh oh!

stevhliu Nov 1, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

tolgacangoz commented Oct 30, 2023 •

edited

Loading

HuggingFaceDocBuilderDev commented Oct 30, 2023 •

edited

Loading