-
Notifications
You must be signed in to change notification settings - Fork 6.1k
[doc wip] literalinclude #2718
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
[doc wip] literalinclude #2718
Conversation
The documentation is not available anymore as the PR was closed or merged. |
--output_dir="sd-pokemon-model" | ||
``` | ||
<literalinclude> | ||
{"path": "../../../../examples/text_to_image/README.md", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this is relative path to examples/text_to_image/README.md
from perspective of current file, which is docs/source/en/training/text2image.mdx
@@ -52,7 +52,7 @@ If you have already cloned the repo, then you won't need to go through these ste | |||
With `gradient_checkpointing` and `mixed_precision` it should be possible to fine tune the model on a single 24GB GPU. For higher `batch_size` and faster training it's better to use GPUs with >30GB memory. | |||
|
|||
**___Note: Change the `resolution` to 768 if you are using the [stable-diffusion-2](https://huggingface.co/stabilityai/stable-diffusion-2) 768x768 model.___** | |||
|
|||
<!-- accelerate_snippet_start --> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
use comment as a marker. In markdowns, you can use html style commenting <!-- bla xyz -->
"start-after": "accelerate_snippet_start", | ||
"end-before": "accelerate_snippet_end", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
use the markers defined https://github.com/huggingface/diffusers/pull/2718/files#r1143348130
This is great! Thank you!! @mishig25 |
Super cool, I've added this to the Documentation Notion in case other teams are interested. Thanks @mishig25 ! |
Nice @mishig25 ! |
@mishig25 is it possible to automatically mirror the README of an example in the corresponding documentation page? For this example, it would be https://github.com/huggingface/diffusers/blob/main/examples/text_to_image and its corresponding doc: https://huggingface.co/docs/diffusers/training/text2image. I think that would be great. |
Working here: https://moon-ci-docs.huggingface.co/docs/diffusers/pr_2718/en/training/text2image