Updated How to Contribute Code (markdown)

comfyanonymous 2024-07-01 12:51:55 -04:00
parent b5bb471f39
commit 9462e82332

@ -1,6 +1,13 @@
## Adding support for new models ## General
Here are a few tips to make reviewing your PR easier for us: For general improvements/bug fixes just make a pull request. Try to make a single pull request for each change to make reviewing easier.
## Special Cases
### Adding support for new models
If you want us to add support for a new model to ComfyUI what we need is:
- Have a minimal implementation of the model code that only depends on pytorch under a license compatible with the GPL license that ComfyUI uses. - Have a minimal implementation of the model code that only depends on pytorch under a license compatible with the GPL license that ComfyUI uses.
- Provide a reference image with sampling settings/seed/etc.. so that I can make sure the ComfyUI implementation matches the reference one. - Provide a reference image with sampling settings/seed/etc.. so that I can make sure the ComfyUI implementation matches the reference one.
@ -28,10 +35,12 @@ def optimized_attention(q, k, v, heads, mask=None, attn_precision=None, skip_res
return out return out
``` ```
Examples in the Code:
[Audio](https://github.com/comfyanonymous/ComfyUI/blob/master/comfy/ldm/audio/dit.py#L369) [Audio](https://github.com/comfyanonymous/ComfyUI/blob/master/comfy/ldm/audio/dit.py#L369)
[SDXL Cascade](https://github.com/comfyanonymous/ComfyUI/blob/master/comfy/ldm/cascade/common.py#L47) [SDXL Cascade](https://github.com/comfyanonymous/ComfyUI/blob/master/comfy/ldm/cascade/common.py#L47)
[mmdit](https://github.com/comfyanonymous/ComfyUI/blob/master/comfy/ldm/modules/diffusionmodules/mmdit.py#L293) [mmdit](https://github.com/comfyanonymous/ComfyUI/blob/master/comfy/ldm/modules/diffusionmodules/mmdit.py#L293)
After that you can just ping me: "comfyanonymous" on [matrix](https://app.element.io/#/room/%23comfyui_space%3Amatrix.org) or "comfy" on [discord](https://discord.com/invite/comfyorg) and I can take a look.