Update README.md

README.md

@@ -17,20 +17,32 @@ By organizing Core ML models in one place, it will be easier to find them and fo
 
 <hr>
 
-## Conversion Flags
+## Base Model Types
 
-The models were converted using the following flags:\
-`--convert-vae-decoder --convert-vae-encoder --convert-unet --convert-text-encoder --bundle-resources-for-swift-cli --attention-implementation {SPLIT_EINSUM or ORIGINAL}`
+Model files with `split_einsum` in the file name are compatible with all compute units.
+
+Model files with `original` in the file name are only compatible with CPU & GPU.
+
+Model files with a `no-i2i` suffix in the file name only work for Text2Image.
+
+Models with a `cn` suffix in the file name (or in their repo name) will work for Text2Image, Image2Image and ControlNet.
+
+Model files with neither a `no-i2i` nor a `cn` suffix in the file name will work for Text2Image and Image2Image.
 
-## Model version: `split_einsum` VS `original`
+**Other Model Types**
 
-Depending on what compute unit you select, you will need to use the correct model version:
-- `split_einsum` is compatible with all compute unit
-- `original` is only compatible with CPU & GPU
+If you are using Mochi Diffusion v3.2, v4.0, or later versions, some model files with neither a `no-i2i` nor a `_cn` suffix in the file name might need a simple modification to enable Image2Image to work correctly.  Please go [HERE](https://huggingface.co/coreml/VAEEncoders) for more information.
+
+The various ControlNet types supported by Mochi Diffusion v4.0 and later are enabled by individual ControlNet models.  Please go [HERE](https://huggingface.co/coreml/ControlNet-Models-For-Core-ML) for a selection of ControlNet models that you can download, and information on their use.
 
 ## Usage
 
-Once the chosen model has been downloaded, simply unzip it to use it.
+Once the chosen base model has been downloaded, simply unzip it and put it in your model folder to use it.
+
+## Conversion Flags
+
+The models were converted using the following flags:\
+`--convert-vae-decoder --convert-vae-encoder --convert-unet --unet-support-controlnet --convert-text-encoder --bundle-resources-for-swift-cli --attention-implementation {SPLIT_EINSUM or ORIGINAL}`
 
 <hr>
 
@@ -51,15 +63,16 @@ Models have the following naming scheme:
 1. Original model name
 1. Model version (`split-einsum` or `original`)
 1. Model size (only if different from `512x512`)
-1. VAE name (only if different from the original VAE)
+1. VAE name (only if different from the original `VAE`)
+1. cn (for models compatible with `ControlNet`)
 
 Each label is separated by an underscore `_`, and all capitalization from the original name is preserved.\
-For example: `stable-diffusion-2-1_original_512x768_ema-vae`.
+For example: `stable-diffusion-1-5_original_512x768_ema-vae_cn`.
 
 ## Repo Name
 
-Repos are named with the original diffusers Hugging Face / Civitai repo name prefixed by `coreml-`.\
-For example: `coreml-stable-diffusion-2-1`.
+Repos are named with the original diffusers Hugging Face / Civitai repo name prefixed by `coreml-` and have a `_cn` suffix if they are ControlNet compatibile.\
+For example: `coreml-stable-diffusion-1-5_cn`.
 
 ## Repo README Contents
 
@@ -72,6 +85,7 @@ tags:
 - coreml
 - stable-diffusion
 - text-to-image
+- not-for-all-eyes  (models where viewer discretion is advised)
 ---
 
 # Core ML converted model