mirror of https://github.com/bmaltais/kohya_ss
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>pull/3290/head
parent
a06a69030a
commit
060c58a319
|
|
@ -4,20 +4,21 @@ Use this method if you prefer `pip` or are on macOS.
|
||||||
|
|
||||||
## Table of Contents
|
## Table of Contents
|
||||||
|
|
||||||
- [Prerequisites](#prerequisites)
|
- [Linux – Installation (pip method)](#linux--installation-pip-method)
|
||||||
- [Installation Steps](#installation-steps)
|
- [Table of Contents](#table-of-contents)
|
||||||
- [Using Conda](#using-conda-optional)
|
- [Prerequisites](#prerequisites)
|
||||||
- [Clone the Repository](#clone-the-repository)
|
- [Installation Steps](#installation-steps)
|
||||||
- [Run the Setup Script](#run-the-setup-script)
|
- [Using `conda`](#using-conda)
|
||||||
- [Start the GUI](#start-the-gui)
|
- [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)
|
- [Available CLI Options](#available-cli-options)
|
||||||
- [Upgrade Instructions](#upgrade-instructions)
|
- [Upgrade Instructions](#upgrade-instructions)
|
||||||
- [Optional: Install Location Details](#optional-install-location-details)
|
- [Optional: Install Location Details](#optional-install-location-details)
|
||||||
|
|
||||||
|
|
||||||
## Prerequisites
|
## 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
|
- **Git** – Required for cloning the repository
|
||||||
- **NVIDIA CUDA Toolkit 12.8**
|
- **NVIDIA CUDA Toolkit 12.8**
|
||||||
- **NVIDIA GPU** – Required for training; VRAM needs vary
|
- **NVIDIA GPU** – Required for training; VRAM needs vary
|
||||||
|
|
@ -29,12 +30,13 @@ Use this method if you prefer `pip` or are on macOS.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
sudo apt update
|
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)
|
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.
|
Follow the instructions for your distribution.
|
||||||
3.
|
3.
|
||||||
|
|
||||||
> [!NOTE]
|
> [!NOTE]
|
||||||
> CUDA is usually not required and may not be compatible with Apple Silicon GPUs.
|
> CUDA is usually not required and may not be compatible with Apple Silicon GPUs.
|
||||||
|
|
||||||
|
|
@ -63,6 +65,7 @@ Clone with submodules:
|
||||||
git clone --recursive https://github.com/bmaltais/kohya_ss.git
|
git clone --recursive https://github.com/bmaltais/kohya_ss.git
|
||||||
cd kohya_ss
|
cd kohya_ss
|
||||||
```
|
```
|
||||||
|
|
||||||
## Run the Setup Script
|
## Run the Setup Script
|
||||||
|
|
||||||
Make the setup script executable:
|
Make the setup script executable:
|
||||||
|
|
@ -80,7 +83,6 @@ Run:
|
||||||
> [!NOTE]
|
> [!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.
|
> 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 the GUI
|
||||||
|
|
||||||
Start with:
|
Start with:
|
||||||
|
|
|
||||||
|
|
@ -5,18 +5,23 @@ If you have macOS please use **pip method**.
|
||||||
|
|
||||||
## Table of Contents
|
## Table of Contents
|
||||||
|
|
||||||
- [Prerequisites](#prerequisites)
|
- [Linux – Installation (uv method)](#linux--installation-uv-method)
|
||||||
- [Installation Steps](#installation-steps)
|
- [Table of Contents](#table-of-contents)
|
||||||
- [Clone the Repository](#clone-the-repository)
|
- [Prerequisites](#prerequisites)
|
||||||
- [Start the GUI](#start-the-gui)
|
- [Installation Steps](#installation-steps)
|
||||||
|
- [Clone the Repository](#clone-the-repository)
|
||||||
|
- [Start the GUI](#start-the-gui)
|
||||||
- [Available CLI Options](#available-cli-options)
|
- [Available CLI Options](#available-cli-options)
|
||||||
- [Upgrade Instructions](#upgrade-instructions)
|
- [Upgrade Instructions](#upgrade-instructions)
|
||||||
- [Optional: Install Location Details](#optional-install-location-details)
|
- [Optional: Install Location Details](#optional-install-location-details)
|
||||||
|
|
||||||
|
|
||||||
## Prerequisites
|
## 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
|
- **Git** – Required for cloning the repository
|
||||||
- **NVIDIA CUDA Toolkit 12.8**
|
- **NVIDIA CUDA Toolkit 12.8**
|
||||||
- **NVIDIA GPU** – Required for training; VRAM needs vary
|
- **NVIDIA GPU** – Required for training; VRAM needs vary
|
||||||
|
|
@ -29,7 +34,7 @@ If you have macOS please use **pip method**.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
sudo apt update
|
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)
|
2. Install [CUDA 12.8 Toolkit](https://developer.nvidia.com/cuda-12-8-0-download-archive?target_os=Linux&target_arch=x86_64)
|
||||||
|
|
@ -106,11 +111,12 @@ 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.
|
1. Open a terminal and navigate to the root directory of the project.
|
||||||
2. Pull the latest changes from the repository:
|
2. Pull the latest changes from the repository:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git pull
|
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
|
## Optional: Install Location Details
|
||||||
|
|
||||||
|
|
@ -135,4 +141,3 @@ If you use interactive mode, the default Accelerate values are:
|
||||||
- Machine: `This machine`
|
- Machine: `This machine`
|
||||||
- Compute: `None`
|
- Compute: `None`
|
||||||
- Others: `No`
|
- Others: `No`
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -14,6 +14,8 @@ Recommended for most Windows users.
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
- [Python 3.11.9](https://www.python.org/ftp/python/3.11.9/python-3.11.9-amd64.exe) – enable "Add to PATH"
|
- [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)
|
- [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)
|
- [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
|
- **NVIDIA GPU** – Required for training; VRAM needs vary
|
||||||
|
|
|
||||||
|
|
@ -1 +1 @@
|
||||||
Subproject commit 61eda7627874f1e0c5e31e710a698c49e8f0e332
|
Subproject commit 3e6935a07edcb944407840ef74fcaf6fcad352f7
|
||||||
Loading…
Reference in New Issue