add: controlnet entry to training section in the docs. #2677

sayakpaul · 2023-03-15T04:40:06Z

Because we should.

HuggingFaceDocBuilderDev · 2023-03-15T04:47:32Z

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

patrickvonplaten

Thanks that looks nice to me! Going forward once we've added doc testing we should maybe think a bit about how we can test such training pages.

This PR is nice - it mirrors what has been done for dreambooth: https://huggingface.co/docs/diffusers/training/dreambooth

@yiyixuxu @stevhliu could you also take a look here?

stevhliu

Super cool! I love that you included examples from the training after 300 and 600 steps. I think this is really reassuring for users who're following along, and they can compare their outputs to these. 👏

docs/source/en/_toctree.yml

stevhliu · 2023-03-15T21:40:54Z

docs/source/en/training/controlnet.mdx

+-->
+
+# ControlNet
+


It'd be nice to give a short intro (2-3 sentences) describing what ControlNet is.

I think we can do that for all the training examples we have in a bulk PR.

stevhliu · 2023-03-15T21:43:21Z

docs/source/en/training/controlnet.mdx

+
+[Adding Conditional Control to Text-to-Image Diffusion Models](https://arxiv.org/abs/2302.05543) (ControlNet) by Lvmin Zhang and Maneesh Agrawala.
+
+This example is based on the [training example in the original ControlNet repository](https://github.com/lllyasviel/ControlNet/blob/main/docs/train.md). It trains a ControlNet to fill circles using a [small synthetic dataset](https://huggingface.co/datasets/fusing/fill50k).


Suggested change

This example is based on the [training example in the original ControlNet repository](https://github.com/lllyasviel/ControlNet/blob/main/docs/train.md). It trains a ControlNet to fill circles using a [small synthetic dataset](https://huggingface.co/datasets/fusing/fill50k).

This guide will show you how to train ControlNet to fill in circles using the [`fill50k`](https://huggingface.co/datasets/fusing/fill50k) dataset. It is based on the [training example](https://github.com/lllyasviel/ControlNet/blob/main/docs/train.md) in the original ControlNet repository.

I think it's not actually a guide, though. We are just showing how to use the example script and not discussing the training methodology (for which the script is there).

I think this is the same thing even if you aren't discussing the training methodology. By showing how to do something, you're still guiding the user. I'm fine with either way though :)

Ah I see your point!

How about we merge it as is for now and then maybe you could open a PR updating all the examples to have a short intro section?

@mishig25 is working on #2718 which would make it simpler to keep the doc of the training section in sync with our READMEs. WDYT?

docs/source/en/training/controlnet.mdx

Co-authored-by: Steven Liu <[email protected]>

sayakpaul · 2023-03-16T03:15:29Z

Going forward once we've added doc testing we should maybe think a bit about how we can test such training pages.

@patrickvonplaten Since the examples are already tested and the training pages are just mirrored copies of those examples, I think it's fine no?

yiyixuxu

this is awesome!

patrickvonplaten · 2023-03-16T15:31:34Z

Going forward once we've added doc testing we should maybe think a bit about how we can test such training pages.

@patrickvonplaten Since the examples are already tested and the training pages are just mirrored copies of those examples, I think it's fine no?

Yes, it's just that we need to ideally find an automated way of keeping those doc pages in sync with the examples

sayakpaul · 2023-03-16T15:32:32Z

Yes, it's just that we need to ideally find an automated way of keeping those doc pages in sync with the examples

You mean mirroring the content of example script READMEs in our docs?

stevhliu

Looks great to me, thanks for all the changes! 👍

stevhliu · 2023-03-20T18:43:56Z

docs/source/en/training/controlnet.mdx

+
+[Adding Conditional Control to Text-to-Image Diffusion Models](https://arxiv.org/abs/2302.05543) (ControlNet) by Lvmin Zhang and Maneesh Agrawala.
+
+This example is based on the [training example in the original ControlNet repository](https://github.com/lllyasviel/ControlNet/blob/main/docs/train.md). It trains a ControlNet to fill circles using a [small synthetic dataset](https://huggingface.co/datasets/fusing/fill50k).


I think this is the same thing even if you aren't discussing the training methodology. By showing how to do something, you're still guiding the user. I'm fine with either way though :)

) * add: controlnet entry to training section in the docs. * formatting. * Apply suggestions from code review Co-authored-by: Steven Liu <[email protected]> * wrap in a tip block. --------- Co-authored-by: Steven Liu <[email protected]>

add: controlnet entry to training section in the docs.

71ae84c

sayakpaul requested review from yiyixuxu and stevhliu March 15, 2023 04:40

formatting.

49b85eb

patrickvonplaten approved these changes Mar 15, 2023

View reviewed changes

stevhliu reviewed Mar 15, 2023

View reviewed changes

sayakpaul and others added 2 commits March 16, 2023 08:42

Apply suggestions from code review

8c99e58

Co-authored-by: Steven Liu <[email protected]>

wrap in a tip block.

5d1e552

Merge branch 'main' into docs/training-overview

2f97cc0

sayakpaul requested a review from stevhliu March 16, 2023 03:20

yiyixuxu approved these changes Mar 16, 2023

View reviewed changes

stevhliu approved these changes Mar 20, 2023

View reviewed changes

sayakpaul merged commit 73bdad0 into main Mar 21, 2023

sayakpaul deleted the docs/training-overview branch March 21, 2023 01:53


		[Adding Conditional Control to Text-to-Image Diffusion Models](https://arxiv.org/abs/2302.05543) (ControlNet) by Lvmin Zhang and Maneesh Agrawala.

		This example is based on the [training example in the original ControlNet repository](https://github.com/lllyasviel/ControlNet/blob/main/docs/train.md). It trains a ControlNet to fill circles using a [small synthetic dataset](https://huggingface.co/datasets/fusing/fill50k).

	This example is based on the [training example in the original ControlNet repository](https://github.com/lllyasviel/ControlNet/blob/main/docs/train.md). It trains a ControlNet to fill circles using a [small synthetic dataset](https://huggingface.co/datasets/fusing/fill50k).
	This guide will show you how to train ControlNet to fill in circles using the [`fill50k`](https://huggingface.co/datasets/fusing/fill50k) dataset. It is based on the [training example](https://github.com/lllyasviel/ControlNet/blob/main/docs/train.md) in the original ControlNet repository.

		-->

		# ControlNet

add: controlnet entry to training section in the docs. #2677

add: controlnet entry to training section in the docs. #2677

Uh oh!

Conversation

sayakpaul commented Mar 15, 2023

Uh oh!

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

Uh oh!

Uh oh!

patrickvonplaten left a comment

Choose a reason for hiding this comment

Uh oh!

stevhliu left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

stevhliu Mar 15, 2023

Choose a reason for hiding this comment

Uh oh!

sayakpaul Mar 16, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

stevhliu Mar 15, 2023

Choose a reason for hiding this comment

Uh oh!

sayakpaul Mar 16, 2023

Choose a reason for hiding this comment

Uh oh!

stevhliu Mar 20, 2023

Choose a reason for hiding this comment

Uh oh!

sayakpaul Mar 21, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sayakpaul commented Mar 16, 2023

Uh oh!

yiyixuxu left a comment

Choose a reason for hiding this comment

Uh oh!

patrickvonplaten commented Mar 16, 2023

Uh oh!

sayakpaul commented Mar 16, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

stevhliu left a comment

Choose a reason for hiding this comment

Uh oh!

stevhliu Mar 20, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

HuggingFaceDocBuilderDev commented Mar 15, 2023 •

edited

Loading

sayakpaul Mar 16, 2023 •

edited

Loading

sayakpaul commented Mar 16, 2023 •

edited

Loading