SimpleTuner

(β˜… 2,901)

A general fine-tuning kit geared toward image/video/audio diffusion models.

  • .dockerignore
  • .envrc
  • .flake8
  • .gitignore
  • .pre-commit-config.yaml
  • AGENTS.md
  • CLAUDE.md
  • cog.yaml
  • docker-compose.yml
  • docker-start.sh
  • Dockerfile
  • GEMINI.md
  • LICENSE
  • MANIFEST.in
  • mkdocs.yml
  • notebook.ipynb
  • package-lock.json
  • package.json
  • predict.py
  • pyproject.toml
  • README.es.md
  • README.hi.md
  • README.ja.md
  • README.md
  • README.pt-BR.md
  • README.zh.md
  • setup.py
  • st_cli.py

# Installation Guide

1. Get the code
git clone https://github.com/bghira/SimpleTuner

Downloads the entire project code from GitHub to your computer.

cd SimpleTuner

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Python 3 Python is required to use pip.
pip install simpletuner

Installs the package published on PyPI directly β€” no need to clone the source.

pip install 'simpletuner[cuda]'

Installs the package published on PyPI directly β€” no need to clone the source.

pip install 'simpletuner[cuda13]' --extra-index-url https://download.pytorch.org/whl/cu130

Installs the package published on PyPI directly β€” no need to clone the source.

pip install 'simpletuner[cuda13-transformerengine]' --extra-index-url https://download.pytorch.org/whl/cu130

Installs the package published on PyPI directly β€” no need to clone the source.

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker compose up -d --build

Builds and starts all defined containers (server, database, etc.) at once, in the background.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

4. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

5. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
pip install simpletuner

Installs the package published on PyPI directly β€” no need to clone the source.

pip install 'simpletuner[cuda]'

Installs the package published on PyPI directly β€” no need to clone the source.

pip install 'simpletuner[cuda13]' --extra-index-url https://download.pytorch.org/whl/cu130

Installs the package published on PyPI directly β€” no need to clone the source.

pip install 'simpletuner[cuda13-transformerengine]' --extra-index-url https://download.pytorch.org/whl/cu130

Installs the package published on PyPI directly β€” no need to clone the source.

pip install 'simpletuner[rocm]' --extra-index-url https://download.pytorch.org/whl/rocm7.1

Installs the package published on PyPI directly β€” no need to clone the source.

βœ… If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

// repository documentation