Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
olegchomp authored Jun 14, 2024
1 parent f0e5d4f commit 73b4ec8
Showing 1 changed file with 23 additions and 21 deletions.
44 changes: 23 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,37 +22,39 @@ Required TouchDesigner 2023 & Python 3.11
#### Install:
1. Install [Python 3.11](https://www.python.org/downloads/release/python-3118/)
2. Install [Git](https://git-scm.com/downloads)
3. Install [CUDA Toolkit](https://developer.nvidia.com/cuda-11-8-0-download-archive) 11.8
3. Install [CUDA Toolkit](https://developer.nvidia.com/cuda-11-8-0-download-archive) 11.8 (required PC restart)
4. Download [TouchDiffusion](https://github.com/olegchomp/TouchDiffusion/archive/refs/heads/main.zip).
5. Open ```webui.bat``` with text editor and set path to Python 3.11 in ```set PYTHON_PATH=```.
6. Run ```webui.bat```

On first run it will create .venv and install dependencies
5. Open ```webui.bat``` with text editor and set path to Python 3.11 in ```set PYTHON_PATH=```. (ex. ```set PYTHON_PATH="C:\Program Files\Python311"```)
6. Run ```webui.bat```. After installation it will provide url to web interface (ex. ```http://127.0.0.1:7860```)
7. Open ```install & update``` tab and run ```Update dependencies```. (could take ~10 minutes, depending on your internet connection)
8. If you get pop up window with error related to .dll, run ```Fix pop up```
9. Restart webui.bat

#### Accelerate model:
Models must be in ```models``` folder or you can set [HF_HOME](https://huggingface.co/docs/huggingface_hub/en/package_reference/environment_variables) in system variables to change this folder.
Models in ```.safetensors``` format must be in ```models\checkpoints``` folder.

1) Run ```webui.bat```
2) Select model or provide model name (will be downloaded if not exists). for ex. `stabilityai/sd-turbo`
4) Set amount of sampling steps (Batch size)
5) Select Turbo (if model is Turbo), LCM (Add LCM Lora), None (for other types)
6) Click submit and wait for acceleration to finish
2) Select model.
4) Set width, height and amount of sampling steps (Batch size)
5) Select acceleration lora.
6) Run ```Make engine``` and wait for acceleration to finish. (could take ~10 minutes, depending on your hardware)

#### TouchDesigner inference:
1. Add **TouchDiffusion.tox** to project
2. On ```Settings``` page change path to ```TouchDiffusion``` folder (same as where webui.bat) and click **Re-init**. (restart project if get errors)
3. On ```Settings``` page select Engine, Acceleration, Batch size (values locked to avaliable for engines) and click **Load Engine**.
4. Connect animated TOP to input. Component cook only if input updates.
2. On ```Settings``` page change path to ```TouchDiffusion``` folder (same as where webui.bat).
3. Save and restart TouchDesigner project.
4. On ```Settings``` page select Engine and click **Load Engine**.
5. Connect animated TOP to input. Component cook only if input updates.

#### Known issues / Roadmap:
* Fix Re-init. Sometimes required to restart TouchDesigner for initializing site-packages.
* Code clean-up and rework.
* Custom resolution (for now fixed 512x512)
* CFG not affecting image
* Add Lora
* Add Hyper Lora support
* Add ControlNet support
* Add SDXL support
- [ ] Fix Re-init. Sometimes required to restart TouchDesigner for initializing site-packages.
- [ ] Code clean-up and rework.
- [x] Custom resolution (for now fixed 512x512)
- [ ] CFG not affecting image
- [ ] Add Lora
- [ ] Add Hyper Lora support
- [ ] Add ControlNet support
- [ ] Add SDXL support

## Acknowledgement
Based on the following projects:
Expand Down

0 comments on commit 73b4ec8

Please sign in to comment.