Skip to content

[doc] add link to training script #3271

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 1 commit into from
Apr 28, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion docs/source/en/training/controlnet.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,12 @@ cd diffusers
pip install -e .
```

Then navigate into the example folder and run:
Then navigate into the [example folder](https://github.com/huggingface/diffusers/tree/main/examples/controlnet)
```bash
cd examples/controlnet
```

Now run:
```bash
pip install -r requirements.txt
```
Expand Down
8 changes: 7 additions & 1 deletion docs/source/en/training/custom_diffusion.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,13 @@ cd diffusers
pip install -e .
```

Then cd in the example folder and run
Then cd into the [example folder](https://github.com/huggingface/diffusers/tree/main/examples/custom_diffusion)

```
cd examples/custom_diffusion
```

Now run

```bash
pip install -r requirements.txt
Expand Down
9 changes: 7 additions & 2 deletions docs/source/en/training/instructpix2pix.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ The output is an "edited" image that reflects the edit instruction applied on th
<img src="https://huggingface.co/datasets/diffusers/docs-images/resolve/main/output-gs%407-igs%401-steps%4050.png" alt="instructpix2pix-output" width=600/>
</p>

The `train_instruct_pix2pix.py` script shows how to implement the training procedure and adapt it for Stable Diffusion.
The `train_instruct_pix2pix.py` script (you can find the it [here](https://github.com/huggingface/diffusers/blob/main/examples/instruct_pix2pix/train_instruct_pix2pix.py)) shows how to implement the training procedure and adapt it for Stable Diffusion.

***Disclaimer: Even though `train_instruct_pix2pix.py` implements the InstructPix2Pix
training procedure while being faithful to the [original implementation](https://github.com/timothybrooks/instruct-pix2pix) we have only tested it on a [small-scale dataset](https://huggingface.co/datasets/fusing/instructpix2pix-1000-samples). This can impact the end results. For better results, we recommend longer training runs with a larger dataset. [Here](https://huggingface.co/datasets/timbrooks/instructpix2pix-clip-filtered) you can find a large dataset for InstructPix2Pix training.***
Expand All @@ -44,7 +44,12 @@ cd diffusers
pip install -e .
```

Then cd in the example folder and run
Then cd in the example folder
```bash
cd examples/instruct_pix2pix
```

Now run
```bash
pip install -r requirements.txt
```
Expand Down