Zabriskije commited on
Commit
7eb4f2a
1 Parent(s): d82b285

Added README template

Browse files
Files changed (1) hide show
  1. README.md +24 -1
README.md CHANGED
@@ -63,7 +63,30 @@ For example: `coreml-stable-diffusion-2-1`.
63
 
64
  ## Repo README Contents
65
 
66
- You can copy the beginning template for the README from one of the repo models that already exists here.\
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
67
  Then copy the original model's README as the body.
68
 
69
  ## Repo Directory Structure
 
63
 
64
  ## Repo README Contents
65
 
66
+ Copy this template and paste it as a header:
67
+
68
+ ```
69
+ ---
70
+ license: creativeml-openrail-m
71
+ tags:
72
+ - coreml
73
+ - stable-diffusion
74
+ - text-to-image
75
+ ---
76
+
77
+ # Core ML converted model
78
+
79
+ This model was converted to Core ML for use on Apple Silicon devices by following Apple's instructions [here](https://github.com/apple/ml-stable-diffusion#-converting-models-to-core-ml).\
80
+ Provide the model to an app such as [Mochi Diffusion](https://github.com/godly-devotion/MochiDiffusion) to generate images.
81
+
82
+ `split_einsum` versions are compatible with all compute units.\
83
+ `original` versions are only compatible with `CPU & GPU`.
84
+
85
+ # <MODEL-NAME-HERE>
86
+
87
+ Sources: [Hugging Face]() - [CivitAI]()
88
+ ```
89
+
90
  Then copy the original model's README as the body.
91
 
92
  ## Repo Directory Structure