Skip to content

[docs] Add overviews to each section#2657

Merged
stevhliu merged 3 commits into
huggingface:mainfrom
stevhliu:overview-sections
Mar 15, 2023
Merged

[docs] Add overviews to each section#2657
stevhliu merged 3 commits into
huggingface:mainfrom
stevhliu:overview-sections

Conversation

@stevhliu

Copy link
Copy Markdown
Member

This PR adds an Overview page to each section (Tutorial, Loading, Pipeline, Optimization, Training) to centralize what users can expect to learn and discover in each section. As the docs grow, we can update this page which will be useful directory for helping users navigate :)

@HuggingFaceDocBuilderDev

HuggingFaceDocBuilderDev commented Mar 13, 2023

Copy link
Copy Markdown

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

@yiyixuxu yiyixuxu left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This is really great!! thank you!👏👏👏👏👏👏👏


Welcome to 🧨 Diffusers! If you're new to diffusion models and generative AI, and want to learn more, then you've come to the right place. These beginner-friendly tutorials are designed to provide a gentle introduction to diffusion models and help you understand the library fundamentals - the core components and how 🧨 Diffusers is meant to be used.

You'll learn how to use a pipeline for inference to rapidly generate samples, and then deconstruct that pipeline to really understand how to use the library as a modular toolbox for building your own diffusion systems. Then in the next lesson, you'll learn how to train your own diffusion model to generate what you want.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

are you referring to the "Understanding pipelines, models and schedulers" doc? are we going to move it to this section?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Same question.

Also, should we briefly mention our dedicated training section that shows how to perform more advanced forms for training with diffusion models?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

are you referring to the "Understanding pipelines, models and schedulers" doc? are we going to move it to this section?

Yeah, I think it'll be really nice to move that to the tutorials since it is such a super important doc for understanding how to use the library, and we want to give it maximum visibility.

Also, should we briefly mention our dedicated training section that shows how to perform more advanced forms for training with diffusion models?

I think its ok if we don't mention that in the overview - since this is just the tutorial section - and we want the learner to focus on one thing first. But at the end of the training doc, we do have a Next steps section linking to the other forms of training available!

@sayakpaul sayakpaul left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Amazing structuring and readability.

Comment thread docs/source/en/using-diffusers/loading_overview.mdx Outdated
Comment thread docs/source/en/using-diffusers/pipeline_overview.mdx Outdated

@patrickvonplaten patrickvonplaten left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Nice!

@patrickvonplaten

Copy link
Copy Markdown
Contributor

Feel free to merge whenever @stevhliu :-)

@stevhliu stevhliu merged commit 1c2c594 into huggingface:main Mar 15, 2023
@stevhliu stevhliu deleted the overview-sections branch March 15, 2023 18:57
w4ffl35 pushed a commit to w4ffl35/diffusers that referenced this pull request Apr 14, 2023
* add overviews to each section

* fix typo in toctree

* apply feedbacks
AmericanPresidentJimmyCarter pushed a commit to AmericanPresidentJimmyCarter/diffusers that referenced this pull request Apr 26, 2024
* add overviews to each section

* fix typo in toctree

* apply feedbacks
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