This repository allows you to set up a AI Horde Worker to generate, post-process or analyze images for others

If you want the latest information or have questions, come to the #local-workers channel in discord

AI Horde Worker reGen

This repo contains the latest implementation for the AI Horde Worker. This will turn your graphics card(s) into a worker for the AI Horde where you will create images for others. You you will receive in turn earn 'kudos' which will give you priority for your own generations.

Please note that AMD card are not currently well supported, but may be in the future. If you are willing to try with your AMD card, join the discord discussion.

Some important details you should know before you start

If you are upgrading from AI-Horde-Worker, you will have to manually move your models folder to the horde-worker-reGen folder. This folder may be named models or nataili (depending on when you installed) and should contain a folder named compvis.
- We recommend you start with a fresh bridge data file (bridgeData_template.yaml -> bridgeData.yaml). See Configure section
When submitting debug information do not publish .log files in the discord server channels - send them to tazlin directly as we cannot guarantee that your API key would not be in it (though, this warning should relax over time).
Do not set threads higher than 2.
Your memory usage will increase up until the number of queued jobs. You should set your queue size to at least 1.
If you have a low amount of system memory (16gb or under), do not attempt a queue size greater than 1 if you have more than one model set to load.
If you plan on running SDXL, you will need to ensure at least 9 gb of system ram remains free.
If you have an 8 gb card, SDXL will only reliably work at max_power values close to 32. 42 was too high for tests on a 2080 in certain cases.

Installing

Please see the prior section before proceeding.

If you haven't already, go to AI Horde and register an account, then store your API key somewhere secure. Treat your API key like a password. You will need it later in these instructions. This will allow your worker to gather kudos for your account.

Windows

Using git (recommended)

Use these instructions if you have installed git for windows.

This option is recommended as it will make keeping your repository up to date much easier.

Open powershell (also referred to as terminal) or cmd from the start menu.
Using cd, navigate to a folder that you want the worker installed in.
- Note that the folder you are in will create a folder named horde-worker-reGen. This folder should not exist before you run the following commands.
- If you want it to be installed in C:\horde\, run the following:
  - cd C:\horde
  - (if the horde folder doesn't exist)
```
cd C:\
mkdir horde
cd C:\horde
```
- If you are using cmd and wish to install on a different drive, include the /d option, as so:
  - cd /d G:\horde
Run the following commands within the folder chosen (the folder horde if using the example above)
```
git clone https://github.com/Haidra-Org/horde-worker-reGen.git
cd horde-worker-reGen
```
Continue with the Basic Usage instructions

Without git

Use these instructions if you do not have git for windows and do not want to install it. These instructions make updating the worker a bit more difficult down the line.

Download the zipped version
Extract it to any folder of your choice
Continue with the Basic Usage instructions

Linux

This assumes you have git installed

Open a bash terminal and run these commands (just copy-paste them all together)

git clone https://github.com/Haidra-Org/horde-worker-reGen.git
cd horde-worker-reGen

Continue with the Basic Usage instructions

Basic Usage

The below instructions refers to horde-bridge or update-runtime. Depending on your OS, append .cmd for windows, or .sh for linux

for example, horde-bridge.cmd and update-runtime.cmd for windows

You can double click the provided script files below from a file explorer or run it from a terminal like bash, cmd depending on your OS. The latter option will allow you to see errors in case of a crash, so it's recommended.

Configure

Manually

Make a copy of bridgeData_template.yaml to bridgeData.yaml
Edit bridgeData.yaml and follow the instructions within to fill in your details.

Starting/stopping

Starting the worker

The first time you install, or when updates are required, see Updating for instructions.
Depending on the type of worker:
- 'Dreamer' worker (image generation): run horde-bridge.
  - Warning: This requires a powerful GPU. You will need a GPU with at least 6GB VRAM and 16GB+ of system RAM.
- 'Alchemy' worker (upscaling, interrogation, etc) is not current supported and will come in a future version of reGen.

Stopping the worker

In the terminal in which it's running, simply press Ctrl+C together.
The worker will finish the current jobs before exiting.

Running with multiple GPUs

In the future you will not need to run multiple worker instances

To use multiple GPUs each has to start their own instance. For linux, you just need to limit the run to a specific card:

CUDA_VISIBLE_DEVICES=0 ./horde-bridge.sh -n "My awesome instance #1"
CUDA_VISIBLE_DEVICES=1 ./horde-bridge.sh -n "My awesome instance #2"

etc

Be warned that you will need a very high (32-64gb+) amount of system ram depending on your settings. queue_size and max_threads increases the amount of ram required per worker substantially.

Updating

The AI Horde workers are under constant improvement. You can follow progress in our discord and get notifications about updates there. If you are interested in receiving notifications for worker updates or betas, go to the #get-roles channel and get the appropriate role(s).

To update:

Shut down your worker by pressing ctrl+c once and waiting for the worker to stop.
Update this repo using the appropriate method:

git method

Use this approach if you cloned the original repository using git clone
1. Open a or bash, cmd, or powershell terminal depending on your OS
2. Navigate to the folder you have the AI Horde Worker repository installed if you're not already there.
3. run git pull
zip method

Use this approach if you downloaded the git repository as a zip file and extracted it somewhere.
1. delete the horde_worker_regen/ directory from your folder
2. Download the repository from github as a zip file
3. Extract its contents into the same the folder you have the AI Horde Worker repository installed, overwriting any existing files
Run the update-runtime script for your OS. This will update all dependencies if required.
- Some updates may not require this and the update notification will tell you if this is the case.
- When in doubt, you should run it anyway.
- Advanced users: If you do not want to use mamba or you are comfortable with python/venvs, see README_advanced.md.
Continue with Starting/stopping instructions above

Docker

See README_advanced.md.

Model Usage

Many models in this project use the CreativeML OpenRAIL License. Please read the full license here.

menonpg/horde-worker-reGen