From ff96143ac55edd875a5d87c02c2b31dc241900ad Mon Sep 17 00:00:00 2001
From: Mathieu Broillet <mathieu@broillet.ch>
Date: Sat, 17 Feb 2024 00:37:40 +0100
Subject: [PATCH] add readme

---
 README.md               | 27 +++++++++++++++++++++++++++
 make_folders.sh         |  2 +-
 start_koyhass.sh        |  1 +
 start_xtts.sh           |  1 +
 stop_koboldai.sh        |  1 +
 stop_koyhass.sh         |  1 +
 stop_llamacpp.sh        |  1 +
 stop_stablediffusion.sh |  1 +
 stop_xtts.sh            |  1 +
 9 files changed, 35 insertions(+), 1 deletion(-)
 create mode 100644 README.md
 create mode 100755 start_koyhass.sh
 create mode 100755 start_xtts.sh
 create mode 100755 stop_koboldai.sh
 create mode 100755 stop_koyhass.sh
 create mode 100755 stop_llamacpp.sh
 create mode 100755 stop_stablediffusion.sh
 create mode 100755 stop_xtts.sh

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..69083bd
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+# ai-suite-rocm
+
+This is a simple project to make hosting local LLM and AI tools easily on Linux with AMD GPUs using ROCM.
+
+To use you have to clone the repo and build the docker image, it's the same image for all the services.
+
+```bash
+git clone https://github.com/M4TH1EU/ai-suite-rocm.git
+cd ai-suite-rocm/
+docker build . -t 'ai-suite-rocm:6.0' -f Dockerfile
+```
+
+Then you can start and stop whichever service you want using their respectives start/stop scripts.
+
+For example, you can start stablediffusion using :
+```bash
+# Start
+./start_stablediffusion.sh
+
+# Stop
+./stop_stablediffusion.sh
+```
+
+
+If like me you like storing all your models and big files on another disk, have a look at the make_folders.sh script (it creates symlinks).
+
+*This has been tested on Fedora 39 with kernel 6.7.4 using latest docker version with an AMD RX 6800 XT.*
diff --git a/make_folders.sh b/make_folders.sh
index 6ba7773..f77d067 100755
--- a/make_folders.sh
+++ b/make_folders.sh
@@ -1,4 +1,4 @@
-mkdir -p stablediffusion koboldai llamacpp
+mkdir -p stablediffusion koboldai llamacpp koyhass xtts
 ln -s '/mnt/DATA/SD_MODELS/' ./stablediffusion/models
 ln -s '/mnt/DATA/LLM_MODELS/' ./koboldai/models
 ln -s '/mnt/DATA/LLM_MODELS/' ./llamacpp/models
diff --git a/start_koyhass.sh b/start_koyhass.sh
new file mode 100755
index 0000000..6626a87
--- /dev/null
+++ b/start_koyhass.sh
@@ -0,0 +1 @@
+/usr/bin/docker-compose up -d koyhass-rocm
diff --git a/start_xtts.sh b/start_xtts.sh
new file mode 100755
index 0000000..90422a1
--- /dev/null
+++ b/start_xtts.sh
@@ -0,0 +1 @@
+/usr/bin/docker-compose up -d xtts-rocm
diff --git a/stop_koboldai.sh b/stop_koboldai.sh
new file mode 100755
index 0000000..7134df9
--- /dev/null
+++ b/stop_koboldai.sh
@@ -0,0 +1 @@
+/usr/bin/docker-compose down kobold-rocm
diff --git a/stop_koyhass.sh b/stop_koyhass.sh
new file mode 100755
index 0000000..76eb3e8
--- /dev/null
+++ b/stop_koyhass.sh
@@ -0,0 +1 @@
+/usr/bin/docker-compose down koyhass-rocm
diff --git a/stop_llamacpp.sh b/stop_llamacpp.sh
new file mode 100755
index 0000000..300d26c
--- /dev/null
+++ b/stop_llamacpp.sh
@@ -0,0 +1 @@
+/usr/bin/docker-compose down llamacpp-rocm
diff --git a/stop_stablediffusion.sh b/stop_stablediffusion.sh
new file mode 100755
index 0000000..2d75b38
--- /dev/null
+++ b/stop_stablediffusion.sh
@@ -0,0 +1 @@
+/usr/bin/docker-compose down stablediff-rocm
diff --git a/stop_xtts.sh b/stop_xtts.sh
new file mode 100755
index 0000000..28aa5b7
--- /dev/null
+++ b/stop_xtts.sh
@@ -0,0 +1 @@
+/usr/bin/docker-compose down xtts-rocm