Repository navigation
[docs] Refactor get started section - #14783
Conversation
|
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update. |
| Remote flags: | ||
|
|
||
| - `--flavor <name>` — sandbox hardware (e.g. `a10g-small`, `h200`, `rtx-pro-6000`). | ||
| - `--flavor <name>` — sandbox hardware (`a10g-small`, `h200`, `rtx-pro-6000`). |
There was a problem hiding this comment.
What's wrong with "e.g."? From the current change, it looks like those are the only two flavors that we offer from the HF Jobs and that is not the case.
There was a problem hiding this comment.
i tend to avoid "e.g" and "i.e" and spell it out because its clearer (adopted from the Google style guide).
updated this to say "for example" so it doesn't look like we only offer those flavors
| ```text | ||
| prompt -> text encoder -> embeddings -+-> UNet/DiT <- scheduler ====xN==== | ||
| noise --------------------------------+ | | ||
| latents -> VAE -> image | ||
| ``` |
There was a problem hiding this comment.
I think we can remove this and replace this with a nice animation or a simple infographic. All our favorite agents are pretty good at generating those at this point.
There was a problem hiding this comment.
i've actually been favoring the simplicity of small/minimal ASCII diagrams like this because they're easier to update and maintain, and more readable for any agents reading the docs!
There was a problem hiding this comment.
Okay in that case, I would have to say that I don't find the ascii diagram to be adding any additional useful info. So, I would remove it. The docs are also for humans to review (IMO, ascii figures are hard for human to parse) and let's not forget that :)
Refactors and updates the Get Started section to match Diffusers better, get to generating an image faster, and be more agent-ready:
index.mdnow includes Modular Diffusers and adds a "Where next" section to help guide usersinstallation.mdupdates Python version, drops stale Windows version notequicktour.mdis trimmed down a bit to be less explanatory and more getting to the pointDiffusionPipelinesection, updates LoRA, merges the quantization/optimization section togethercli.mddoes some basic cleanup to split dense sections