Model reference for AIHorde Worker.
- See https://github.com/Haidra-Org/horde-model-reference#horde-moderatorssupport-staff. Note that the venv the worker is installed in has
horde-model-reference
already installed. - Always use
.safetensors
files - Models added must always have an embedded VAE.
- Always test that the worker can load the models. You can request the
customizer
role from the horde admins in discord. - Models which can readily be reproduced by a base model + LoRa should be avoided.
- Double check if the model has trigger words or a specific parameter requirement, such as
clip_skip: 2
. - Be sure that you select the pruned version of a model, if it exists.
- The pruned version of models only remove training data. This has no impact on the horde, however, unpruned models are typically much larger.
- Models selected from civitai should have extra care to be taken:
- The download URL should be fully qualified and include all of the query data, such as
?type=Model&format=SafeTensor&size=pruned&fp=fp16
- When selecting a version, try and prefer models which require fewer steps (such as lightning models) and those model versions which are shown to be popular.
- Double, triple, and quadrple check that the SHA you've specified in the json matches the model type and format URL you've chosen.
- The download URL should be fully qualified and include all of the query data, such as
- When adding large numbers of models, please strongly consider also proposing removing certain low usage models.
- When removing models, please also consider if the model may simply be niche but still useful. Low usage alone is not a disqualifier for inclusion on the model list.
- If an added model can generate NSFW content/has NSFW training data, set
nsfw: true
. Unless a model has been explicitly censored and cleaned of NSFW content, it is better set this totrue
- If your model change affects a top 10 model (by changing it or removing it, metadata-only changes for accuracy are alwasys OK), you must go through the consensus process on loomio in order for that change to be accepted.
- When you are ready for a review of your model change PR, add the
ready-for-review
label and the #image-model-reference channel in discord will start receiving notifications with a breakdown of the changes. - Once the PR is merged, be sure to create a new release from the main repo page. You can do this from that page on the right, click 'releases' and then 'Draft new release' and be sure to set a tag version starting with
v
that is later than the last tag. For example, if the last tag wasv0.0.9
the next one should bev0.0.10
.