Zabriskije commited on
Commit
6815b8c
β€’
1 Parent(s): 0775dc3

Added i2i suffix info, modified naming scheme listing

Browse files
Files changed (1) hide show
  1. README.md +30 -22
README.md CHANGED
@@ -7,50 +7,58 @@ tags:
7
  - stable-diffusion
8
  ---
9
 
10
- ↓↓↓ **Scroll down to see models** ↓↓↓<br><br>
11
 
12
  # Core ML Models Repository
13
 
14
- Thanks to Apple engineers, we can now run Stable Diffusion on Apple Silicon using Core ML!<br>
15
- However its hard to find compatible models and converting models isn't the easiest thing to do.<br>
16
- By organizing Core ML models in one place, hopefully it will be easier to find them and for everyone to benefit.
17
 
18
  ## Conversion Flags
19
 
20
- The models were converted using the following flags:<br>
21
- `--convert-vae-decoder --convert-unet --convert-text-encoder --bundle-resources-for-swift-cli --attention-implementation {SPLIT_EINSUM or ORIGINAL}`
22
 
23
  ## `split_einsum` vs `original` Models
24
 
25
- Depending on what compute unit you select, you will need to use the correct model version.<br>
26
- Some model versions may also generate other image sizes and are named as such.
 
27
 
28
- `split_einsum` version is compatible with all compute unit options including Neural Engine.<br>
29
- `original` version is only compatible with CPU & GPU option.
30
 
31
- ## Contributing
 
32
 
33
- Before joining the community, we encourage you to have at least one model converted (that this community doesn't already have) under your account that you would be able to contribute before joining the community. This will help us to see those who can actually contribute back to the community.<br>
34
- [Contact us on Discord if you are interested in helping out.](https://discord.gg/x2kartzxGv)
 
35
 
36
- ### Models Name
37
 
38
- Models have the following naming scheme: original model name, model version (`split-einsum` or `original`), model size (only if different from `512x512`), vae name (only if different from the original vae).<br>
39
- Each label is separated by an underscore `_`, and all capitalization from the original name are preserved.<br>
 
 
 
 
 
 
 
40
  For example: `stable-diffusion-2-1_original_512x768_ema-vae`.
41
 
42
- ### Repo Name
43
 
44
- Repos are named with the original diffusers Hugging Face repo name prefixed by `coreml-`.<br>
45
- All capitalization from the original name are preserved.<br>
46
  For example: `coreml-stable-diffusion-2-1`.
47
 
48
- ### Repo README Contents
49
 
50
- You can copy the beginning template for the README from one of the repo models that already exists here.<br>
51
  Then copy the original model's README as the body.
52
 
53
- ### Repo Directory Structure
54
 
55
  ```
56
  coreml-stable-diffusion-2-1
 
7
  - stable-diffusion
8
  ---
9
 
10
+ ↓↓↓ **Scroll down to see models** ↓↓↓
11
 
12
  # Core ML Models Repository
13
 
14
+ Thanks to Apple engineers, we can now run Stable Diffusion on Apple Silicon using Core ML!\
15
+ However, it is hard to find compatible models, and converting models isn't the easiest thing to do.\
16
+ By organizing Core ML models in one place, it will be easier to find them and for everyone to benefit.
17
 
18
  ## Conversion Flags
19
 
20
+ The models were converted using the following flags:\
21
+ `--convert-vae-decoder --convert-vae-encoder --convert-unet --convert-text-encoder --bundle-resources-for-swift-cli --attention-implementation {SPLIT_EINSUM or ORIGINAL}`
22
 
23
  ## `split_einsum` vs `original` Models
24
 
25
+ Depending on what compute unit you select, you will need to use the correct model version:
26
+ - `split_einsum` is compatible with all compute unit
27
+ - `original` is only compatible with CPU & GPU
28
 
29
+ # Contributing
 
30
 
31
+ We encourage you to have at least one model converted (that this community doesn't already have) under your account that you would be able to contribute before joining. This will help us see those who can actually contribute back to the community.\
32
+ We also encourage you to follow [models](#models-name) and [repo](#repo-name) naming schemes accordingly.
33
 
34
+ **Attention**: Apple introduced Image-to-image capabilities in the [ml-stable-diffusion 0.2.0 release](https://github.com/apple/ml-stable-diffusion/releases/tag/0.2.0). All the models that do not have a VAE encoder (hence, not will be able to use Image-to-image), will have a `no-i2i` suffix right after the model name.\
35
+ For example: `stable-diffusion-2-1_no-i2i_original`.\
36
+ From now on, only models with a VAE encoder will be accepted.
37
 
38
+ [Contact us on Discord if you are interested in helping out](https://discord.gg/x2kartzxGv).
39
 
40
+ ## Models Name
41
+
42
+ Models have the following naming scheme:
43
+ 1. Original model name
44
+ 1. Model version (`split-einsum` or `original`)
45
+ 1. Model size (only if different from `512x512`)
46
+ 1. VAE name (only if different from the original VAE)
47
+
48
+ Each label is separated by an underscore `_`, and all capitalization from the original name is preserved.\
49
  For example: `stable-diffusion-2-1_original_512x768_ema-vae`.
50
 
51
+ ## Repo Name
52
 
53
+ Repos are named with the original diffusers Hugging Face / Civitai repo name prefixed by `coreml-`.\
 
54
  For example: `coreml-stable-diffusion-2-1`.
55
 
56
+ ## Repo README Contents
57
 
58
+ You can copy the beginning template for the README from one of the repo models that already exists here.\
59
  Then copy the original model's README as the body.
60
 
61
+ ## Repo Directory Structure
62
 
63
  ```
64
  coreml-stable-diffusion-2-1