Add MacOS support

README.md

@@ -44,6 +44,17 @@ If you run on Linux and would like to use the GUI, there is now a port of it as
 ### Runpod
 Follow the instructions found in this discussion: https://github.com/bmaltais/kohya_ss/discussions/379
 
+### MacOS
+In the terminal, run
+
+```
+git clone https://github.com/bmaltais/kohya_ss.git
+cd kohya_ss
+bash macos_setup.sh
+```
+
+During the accelerate config screen after running the script answer "This machine", "None", "No" for the remaining questions.
+
 ### Ubuntu
 In the terminal, run
 
@@ -99,7 +110,17 @@ Run the following commands to install:
 python .\tools\cudann_1.8_install.py
 ```
 
-## Upgrading
+## Upgrading MacOS
+
+When a new release comes out, you can upgrade your repo with the following commands in the root directory:
+
+```bash
+upgrade_macos.sh
+```
+
+Once the commands have completed successfully you should be ready to use the new version.
+
+## Upgrading Windows
 
 When a new release comes out, you can upgrade your repo with the following commands in the root directory:
 
@@ -192,6 +213,10 @@ This will store your a backup file with your current locally installed pip packa
 
 ## Change History
 
+* 2023/03/25 (v21.3.4)
+    - Added untested support for MacOS base on this gist: https://gist.github.com/jstayco/9f5733f05b9dc29de95c4056a023d645
+
+    Let me know how this work. From the look of it it appear to be well tought out. I modified a few things to make it fit better with the rest of the code in the repo.
 * 2023/03/24 (v21.3.3)
     - Add support for custom user gui files. THey will be created at installation time or when upgrading is missing. You will see two files in the root of the folder. One named `gui-user.bat` and the other `gui-user.ps1`. Edit the file based on your prefered terminal. Simply add the parameters you want to pass the gui in there and execute it to start the gui with them. Enjoy!
 * 2023/03/23 (v21.3.2)

gui_macos.sh

@@ -0,0 +1,13 @@
+#!/bin/bash
+
+# Activate the virtual environment
+source venv/bin/activate
+
+# Validate the requirements and store the exit code
+python tools/validate_requirements.py --requirements requirements_macos.txt
+exit_code=$?
+
+# If the exit code is 0, run the kohya_gui.py script with the command-line arguments
+if [ $exit_code -eq 0 ]; then
+    python kohya_gui.py "$@"
+fi

macos_setup.sh

@@ -0,0 +1,38 @@
+#!/bin/bash
+# The initial setup script to prep the environment on macOS
+# xformers has been omitted as that is for Nvidia GPUs only
+
+if ! command -v brew >/dev/null; then
+  echo "Please install homebrew first. This is a requirement for the remaining setup."
+  echo "You can find that here: https://brew.sh"
+  exit 1
+fi
+
+# Install base python packages
+echo "Installing Python 3.10 if not found."
+brew ls --versions python@3.10 >/dev/null || brew install python@3.10
+echo "Installing Python-TK 3.10 if not found."
+brew ls --versions python-tk@3.10 >/dev/null || brew install python-tk@3.10
+
+if command -v python3.10 >/dev/null; then
+  python3.10 -m venv venv
+  source venv/bin/activate
+
+  # DEBUG ONLY
+  #pip install pydevd-pycharm~=223.8836.43
+
+  # Tensorflow installation
+  if wget https://github.com/apple/tensorflow_macos/releases/download/v0.1alpha3/tensorflow_macos-0.1a3-cp38-cp38-macosx_11_0_arm64.whl /tmp; then
+    python -m pip install tensorflow==0.1a3 -f https://github.com/apple/tensorflow_macos/releases/download/v0.1alpha3/tensorflow_macos-0.1a3-cp38-cp38-macosx_11_0_arm64.whl
+    rm -f /tmp/tensorflow_macos-0.1a3-cp38-cp38-macosx_11_0_arm64.whl
+  fi
+
+  pip install torch==2.0.0 torchvision==0.15.1 -f https://download.pytorch.org/whl/cpu/torch_stable.html
+  python -m pip install --use-pep517 --upgrade -r requirements_macos.txt
+  accelerate config
+  echo -e "Setup finished! Run ./gui.sh to start."
+else
+  echo "Python not found. Please ensure you install Python."
+  echo "The brew command for Python 3.10 is: brew install python@3.10"
+  exit 1
+fi

tools/validate_requirements.py

@@ -1,11 +1,17 @@
 import os
 import sys
 import pkg_resources
+import argparse
+
+# Parse command line arguments
+parser = argparse.ArgumentParser(description="Validate that requirements are satisfied.")
+parser.add_argument('-r', '--requirements', type=str, default='requirements.txt', help="Path to the requirements file.")
+args = parser.parse_args()
 
 print("Validating that requirements are satisfied.")
 
-# Load the requirements from the requirements.txt file
-with open('requirements.txt') as f:
+# Load the requirements from the specified requirements file
+with open(args.requirements) as f:
     requirements = f.readlines()
 
 # Check each requirement against the installed packages
@@ -34,7 +40,7 @@ if missing_requirements or wrong_version_requirements:
         for requirement, expected_version, actual_version in wrong_version_requirements:
             print(f" - {requirement} (expected version {expected_version}, found version {actual_version})")
     upgrade_script = "upgrade.ps1" if os.name == "nt" else "upgrade.sh"
-    print(f"\nRun \033[33m{upgrade_script}\033[0m or \033[33mpip install -U -r requirements.txt\033[0m to resolve the missing requirements listed above...")
+    print(f"\nRun \033[33m{upgrade_script}\033[0m or \033[33mpip install -U -r {args.requirements}\033[0m to resolve the missing requirements listed above...")
 
     sys.exit(1)
 

upgrade_macos.sh

@@ -0,0 +1,16 @@
+#!/bin/bash
+
+# Check if there are any changes that need to be committed
+if [[ -n $(git status --short) ]]; then
+    echo "There are changes that need to be committed. Please stash or undo your changes before running this script." >&2
+    exit 1
+fi
+
+# Pull the latest changes from the remote repository
+git pull
+
+# Activate the virtual environment
+source venv/bin/activate
+
+# Upgrade the required packages
+pip install --upgrade -r requirements_macos.txt