From 060c58a3191e3d40972f9e17cf993e8ff998b3ed Mon Sep 17 00:00:00 2001 From: bmaltais Date: Mon, 16 Jun 2025 07:28:39 -0400 Subject: [PATCH] Docs python version uv (#3289) * Docs: Explain .python-version file for uv installs I've updated the Linux and Windows uv installation guides to explain that you can specify the Python version for the uv environment by editing the .python-version file at the root of the repository. * Update linux documentation --------- Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com> --- docs/Installation/pip_linux.md | 30 ++++++++++++++++-------------- docs/Installation/uv_linux.md | 33 +++++++++++++++++++-------------- docs/Installation/uv_windows.md | 2 ++ sd-scripts | 2 +- 4 files changed, 38 insertions(+), 29 deletions(-) diff --git a/docs/Installation/pip_linux.md b/docs/Installation/pip_linux.md index daf439d..261bd36 100644 --- a/docs/Installation/pip_linux.md +++ b/docs/Installation/pip_linux.md @@ -4,20 +4,21 @@ Use this method if you prefer `pip` or are on macOS. ## Table of Contents -- [Prerequisites](#prerequisites) -- [Installation Steps](#installation-steps) -- [Using Conda](#using-conda-optional) -- [Clone the Repository](#clone-the-repository) -- [Run the Setup Script](#run-the-setup-script) -- [Start the GUI](#start-the-gui) +- [Linux – Installation (pip method)](#linux--installation-pip-method) + - [Table of Contents](#table-of-contents) + - [Prerequisites](#prerequisites) + - [Installation Steps](#installation-steps) + - [Using `conda`](#using-conda) + - [Clone the Repository](#clone-the-repository) + - [Run the Setup Script](#run-the-setup-script) + - [Start the GUI](#start-the-gui) - [Available CLI Options](#available-cli-options) -- [Upgrade Instructions](#upgrade-instructions) -- [Optional: Install Location Details](#optional-install-location-details) - + - [Upgrade Instructions](#upgrade-instructions) + - [Optional: Install Location Details](#optional-install-location-details) ## Prerequisites -- **Python 3.10.9** (or higher, but below 3.11) +- **Python 3.10.9** (or higher, but below 3.13) - **Git** – Required for cloning the repository - **NVIDIA CUDA Toolkit 12.8** - **NVIDIA GPU** – Required for training; VRAM needs vary @@ -29,13 +30,14 @@ Use this method if you prefer `pip` or are on macOS. ```bash sudo apt update -sudo apt install python3.10 python3.10-venv git +sudo apt install python3.11 python3.11-venv git ``` 2. Install [CUDA 12.8 Toolkit](https://developer.nvidia.com/cuda-12-8-0-download-archive?target_os=Linux&target_arch=x86_64) Follow the instructions for your distribution. -3. -> [!NOTE] +3. + +> [!NOTE] > CUDA is usually not required and may not be compatible with Apple Silicon GPUs. ### Using `conda` @@ -63,6 +65,7 @@ Clone with submodules: git clone --recursive https://github.com/bmaltais/kohya_ss.git cd kohya_ss ``` + ## Run the Setup Script Make the setup script executable: @@ -80,7 +83,6 @@ Run: > [!NOTE] > If you need additional options or information about the runpod environment, you can use `setup.sh -h` or `setup.sh --help` to display the help message. - ## Start the GUI Start with: diff --git a/docs/Installation/uv_linux.md b/docs/Installation/uv_linux.md index 8277cd4..9db9f12 100644 --- a/docs/Installation/uv_linux.md +++ b/docs/Installation/uv_linux.md @@ -5,18 +5,23 @@ If you have macOS please use **pip method**. ## Table of Contents -- [Prerequisites](#prerequisites) -- [Installation Steps](#installation-steps) -- [Clone the Repository](#clone-the-repository) -- [Start the GUI](#start-the-gui) +- [Linux – Installation (uv method)](#linux--installation-uv-method) + - [Table of Contents](#table-of-contents) + - [Prerequisites](#prerequisites) + - [Installation Steps](#installation-steps) + - [Clone the Repository](#clone-the-repository) + - [Start the GUI](#start-the-gui) - [Available CLI Options](#available-cli-options) -- [Upgrade Instructions](#upgrade-instructions) -- [Optional: Install Location Details](#optional-install-location-details) - + - [Upgrade Instructions](#upgrade-instructions) + - [Optional: Install Location Details](#optional-install-location-details) ## Prerequisites -- **Python 3.10.9** (or higher, but below 3.11) +- **Python 3.10.9** (or higher, but below 3.13) + +> [!NOTE] +> The `uv` environment will use the Python version specified in the `.python-version` file at the root of the repository. You can edit this file to change the Python version used by `uv`. + - **Git** – Required for cloning the repository - **NVIDIA CUDA Toolkit 12.8** - **NVIDIA GPU** – Required for training; VRAM needs vary @@ -29,8 +34,8 @@ If you have macOS please use **pip method**. ```bash sudo apt update -sudo apt install python3.10 python3.10-venv git -``` +sudo apt install python3.11 python3.11-venv git +``` 2. Install [CUDA 12.8 Toolkit](https://developer.nvidia.com/cuda-12-8-0-download-archive?target_os=Linux&target_arch=x86_64) Follow the instructions for your distribution. @@ -104,13 +109,14 @@ This script utilizes the `uv` managed environment. To upgrade your installation to a new version, follow the instructions below. -1. Open a terminal and navigate to the root directory of the project. -2. Pull the latest changes from the repository: +1. Open a terminal and navigate to the root directory of the project. +2. Pull the latest changes from the repository: + ```bash git pull ``` -3. Updates to the Python environment are handled automatically when you next run the `gui-uv.sh` script. No separate setup script execution is needed. +3. Updates to the Python environment are handled automatically when you next run the `gui-uv.sh` script. No separate setup script execution is needed. ## Optional: Install Location Details @@ -135,4 +141,3 @@ If you use interactive mode, the default Accelerate values are: - Machine: `This machine` - Compute: `None` - Others: `No` - diff --git a/docs/Installation/uv_windows.md b/docs/Installation/uv_windows.md index c3d552a..a7e0017 100644 --- a/docs/Installation/uv_windows.md +++ b/docs/Installation/uv_windows.md @@ -14,6 +14,8 @@ Recommended for most Windows users. ## Prerequisites - [Python 3.11.9](https://www.python.org/ftp/python/3.11.9/python-3.11.9-amd64.exe) – enable "Add to PATH" +> [!NOTE] +> The `uv` environment will use the Python version specified in the `.python-version` file at the root of the repository. You can edit this file to change the Python version used by `uv`. - [Git for Windows](https://git-scm.com/download/win) - [CUDA Toolkit 12.8](https://developer.nvidia.com/cuda-12-8-0-download-archive?target_os=Windows&target_arch=x86_64) - **NVIDIA GPU** – Required for training; VRAM needs vary diff --git a/sd-scripts b/sd-scripts index 61eda76..3e6935a 160000 --- a/sd-scripts +++ b/sd-scripts @@ -1 +1 @@ -Subproject commit 61eda7627874f1e0c5e31e710a698c49e8f0e332 +Subproject commit 3e6935a07edcb944407840ef74fcaf6fcad352f7