Zabriskije commited on
Commit
dd81ef7
β€’
1 Parent(s): 717aace

Added naming scheme for models

Browse files
Files changed (1) hide show
  1. README.md +15 -8
README.md CHANGED
@@ -7,18 +7,18 @@ tags:
7
  - stable-diffusion
8
  ---
9
 
10
- # Core ML Models Repository
11
 
12
- ↓↓↓ **Scroll down to see models** ↓↓↓
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-unet --convert-text-encoder --convert-vae-decoder --bundle-resources-for-swift-cli --attention-implementation {SPLIT_EINSUM or ORIGINAL}`
22
 
23
  ## `split_einsum` vs `original` Models
24
 
@@ -33,9 +33,16 @@ Some model versions may also generate other image sizes and are named as such.
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
  ### Repo Name
37
 
38
- Repos are named with the original diffusers Hugging Face repo name prefixed by `coreml-`. So for example, `coreml-stable-diffusion-2-1`.
 
39
 
40
  ### Repo README Contents
41
 
@@ -48,9 +55,9 @@ Then copy the original model's README as the body.
48
  coreml-stable-diffusion-2-1
49
  β”œβ”€β”€ README.md
50
  β”œβ”€β”€ original
51
- β”‚ β”œβ”€β”€ stable-diffusion-2-1_original_compiled.zip
52
- β”‚ β”œβ”€β”€ stable-diffusion-2-1_512x768_original_compiled.zip
53
  β”‚ └── ...
54
  └── split_einsum
55
- └── stable-diffusion-2-1_split-einsum_compiled.zip
56
  ```
 
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
 
 
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 is 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
+ For example: `coreml-stable-diffusion-2-1`.
46
 
47
  ### Repo README Contents
48
 
 
55
  coreml-stable-diffusion-2-1
56
  β”œβ”€β”€ README.md
57
  β”œβ”€β”€ original
58
+ β”‚ β”œβ”€β”€ stable-diffusion-2-1_original.zip
59
+ β”‚ β”œβ”€β”€ stable-diffusion-2-1_original_512x768.zip
60
  β”‚ └── ...
61
  └── split_einsum
62
+ └── stable-diffusion-2-1_split-einsum.zip
63
  ```