Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
halfaipg authored Oct 26, 2024
1 parent 151fc9c commit cc87902
Showing 1 changed file with 2 additions and 25 deletions.
27 changes: 2 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,3 @@
# AI Horde image model reference
# AI Power Grid image model reference

Model reference for [AIHorde](https://aihorde.net) [Worker](https://github.com/Haidra-Org/horde-worker-reGen).

## Notes to maintainers

- 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.
- 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 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](https://loomio.haidra.net/) in order for that change to be accepted.

### PRs/Release notify
- When you are ready for a review of your model change PR, add the `ready-for-review` label and the [#image-model-reference ](https://discord.com/channels/781145214752129095/1290309549290422314) 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 was `v0.0.9` the next one should be `v0.0.10`.
Model and image reference library for [AIPG](https://api.aipowergrid.io) [Worker](https://github.com/AIPowerGrid/image-worker.git).

0 comments on commit cc87902

Please sign in to comment.