kohya-ss / kohya-ss/sd-scripts

`--fp8_base` is not supported with default install instructions; newer torch is required in `README.md` (alongside some other suggested changes to README.md)

Open
#1,176 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
7.2k
Forks
1.2k
Avg merge
11m
Merged PRs (30d)
2

Description

`--fp8_base` is an implemented commandline arg in sd-scripts for (SDXL_)train_network.py, and yet the install instructions in README.md still have the outdated and incompatible Torch v2.0.1.

I propose the following install commands:
```
git clone https://github.com/kohya-ss/sd-scripts.git
cd sd-scripts

python -m venv venv
.\venv\Scripts\activate

pip install torch==2.1.0 torchvision xformers --index-url https://download.pytorch.org/whl/cu121
pip install --upgrade -r requirements.txt
pip install prodigyopt dadaptation

python -m pip install bitsandbytes==0.41.1 --prefer-binary --extra-index-url=https://jllllll.github.io/bitsandbytes-windows-webui

accelerate config
```
This incorporates a compatible version of torch into sd-scripts, while automatically installing a compatible version of torchvision and xformers without needing to specify exact versions.

Many people use the LR-free optimisers of prodigy and dadaptation (with its variants), and I do not see how their ambient presence in an sd-scripts install could harm said install. If someone explicitly does not wish to have the optimisers installed, then they will likely have the experience to simply not run the command that installs them.

Additionally, I do not see a need for bitsandbytes to be optional, so it should also be returned to the main list of install instructions. Repeating what I said regarding the LR-free optimisers, if someone explicitly does not wish to have bitsandbytes installed, then they will likely have the experience to simply not run the command that installs it.

This probably should have been a PR, but I believed the change was slight enough to not necessitate it, and I lack the necessary experience with github to write a proper PR.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reading the installation section in README.md and checking the --fp8_base references in (SDXL_)train_network.py. Compare the proposed Torch, torchvision, xformers, prodigyopt, dadaptation, and bitsandbytes commands with the current instructions; done means README.md clearly documents the agreed supported installation path and dependency guidance.

Written by the indexing model from the issue text.

Assessment

Tech stack
python, pytorch
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.