Skip to content

[docs] Reorganize table of contents #2671

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

Merged
merged 4 commits into from
Mar 15, 2023
Merged

Conversation

stevhliu
Copy link
Member

@stevhliu stevhliu commented Mar 14, 2023

From our discussion in the roadmap, this PR reorganizes the toctree to:

  • Move Understanding pipelines, models and schedulers into the Tutorials because it's an essential doc for learning how to write your own diffusion system and understanding the library is a toolbox.
  • Hiding Removing this Configuration page because it already exists in the API section here (added the to_json_file and to_json_string functions here, so no info is lost).
  • Rename some sections so they're more precise.
  • Move Controlling generation to concept guides because it's an explanatory doc rather than an action-oriented doc.
  • Move the Training section up for more visibility.

@HuggingFaceDocBuilderDev
Copy link

HuggingFaceDocBuilderDev commented Mar 14, 2023

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

Copy link
Contributor

@patrickvonplaten patrickvonplaten left a comment

Choose a reason for hiding this comment

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

Nice refactor!

Copy link
Collaborator

@yiyixuxu yiyixuxu left a comment

Choose a reason for hiding this comment

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

Awesome! Thank you!

@patrickvonplaten
Copy link
Contributor

Feel free to merge @stevhliu

@stevhliu stevhliu merged commit 588e50b into huggingface:main Mar 15, 2023
@stevhliu stevhliu deleted the reorg-docs branch March 15, 2023 23:28
w4ffl35 pushed a commit to w4ffl35/diffusers that referenced this pull request Apr 14, 2023
* reorg toc

* reorg toc some more

* remove duplicate config
AmericanPresidentJimmyCarter pushed a commit to AmericanPresidentJimmyCarter/diffusers that referenced this pull request Apr 26, 2024
* reorg toc

* reorg toc some more

* remove duplicate config
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.

4 participants