mlboydaisuke commited on
Commit
3c182bd
·
verified ·
1 Parent(s): 2ff743e

Mirror of mlboydaisuke/AdcSR-CoreAI

Browse files
.gitattributes CHANGED
@@ -33,3 +33,5 @@ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
33
  *.zip filter=lfs diff=lfs merge=lfs -text
34
  *.zst filter=lfs diff=lfs merge=lfs -text
35
  *tfevents* filter=lfs diff=lfs merge=lfs -text
 
 
 
33
  *.zip filter=lfs diff=lfs merge=lfs -text
34
  *.zst filter=lfs diff=lfs merge=lfs -text
35
  *tfevents* filter=lfs diff=lfs merge=lfs -text
36
+ adcsr_x4_float16.aimodel/main.mlirb filter=lfs diff=lfs merge=lfs -text
37
+ adcsr_x4_float32.aimodel/main.mlirb filter=lfs diff=lfs merge=lfs -text
LICENSE ADDED
@@ -0,0 +1,201 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
README.md ADDED
@@ -0,0 +1,104 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: openrail++
3
+ library_name: coreai
4
+ pipeline_tag: image-to-image
5
+ tags:
6
+ - super-resolution
7
+ - diffusion
8
+ - core-ai
9
+ - apple
10
+ - on-device
11
+ - adcsr
12
+ - stable-diffusion
13
+ ---
14
+
15
+ > **Mirror** of [`mlboydaisuke/AdcSR-CoreAI`](https://huggingface.co/mlboydaisuke/AdcSR-CoreAI) — the canonical repo ([CoreAI Model Zoo](https://github.com/john-rocky/coreai-model-zoo)). Updates land there first.
16
+
17
+
18
+ # AdcSR ×4 Super-Resolution — Core AI
19
+
20
+ On-device **×4 super-resolution** with **AdcSR** ([Adversarial Diffusion Compression](https://github.com/Guaishou74851/AdcSR),
21
+ CVPR 2025) converted for Apple's **Core AI** stack. AdcSR compresses the one-step diffusion model
22
+ [OSEDiff](https://github.com/cswry/OSEDiff) into a small **diffusion-GAN**: a pruned Stable
23
+ Diffusion 2.1 UNet + a half-size VAE decoder, run in **one forward pass** — no iterative denoising,
24
+ no prompt, no noise — so it is fast and small enough to run fully on-device, including iPhone.
25
+
26
+ <!-- gen-cards:use-it begin id=adcsr-x4 (managed by scripts/gen-cards — edit cards.json / QuickStart.swift, not this block) -->
27
+ ## Use it
28
+
29
+ ▶️ **Run it (source)** — the [UpscaleDemo runner](https://github.com/john-rocky/coreai-kit/tree/main/Examples/UpscaleDemo)
30
+ (pick a photo, upscale it ×4 on-device):
31
+
32
+ ```bash
33
+ git clone https://github.com/john-rocky/coreai-kit
34
+ open coreai-kit/Examples/UpscaleDemo/UpscaleDemo.xcodeproj
35
+ # → Run, pick a photo — the app loads AdcSR ×4 (the catalog's superResolution entry) automatically
36
+
37
+ # agents / headless (macOS):
38
+ cd coreai-kit/Examples/UpscaleDemo
39
+ swift run upscale-cli --model adcsr-x4 --image sample_small.png --output big.png
40
+ ```
41
+
42
+ 💻 **Build with it** — complete; the glue is kit API, copy-paste runs:
43
+
44
+ ```swift
45
+ import CoreAIKitVision
46
+
47
+ let resolver = try await SuperResolver(catalog: "adcsr-x4")
48
+ let image = try ImageFile.load(imageURL) // any image file → CGImage + EXIF orientation
49
+ let upscaled = try await resolver.upscale(image.cgImage)
50
+ // upscaled: CGImage — 4× the input's pixels
51
+ ```
52
+
53
+ The take-home is [`Examples/UpscaleDemo/Sources/QuickStart.swift`](https://github.com/john-rocky/coreai-kit/blob/main/Examples/UpscaleDemo/Sources/QuickStart.swift)
54
+ — this exact code as one typed function, no UI; the CLI is an argument shell over it, and
55
+ the GUI runs the same resolver on the photo you pick.
56
+ Big photos? Inputs are tiled and feather-blended internally; `maxInputSide` (default 512)
57
+ caps the input first so a full-res phone photo can't produce a gigapixel result.
58
+
59
+ **Integration checklist**
60
+
61
+ - SPM: `https://github.com/john-rocky/coreai-kit` → product **CoreAIKitVision**
62
+ - Info.plist: none needed
63
+ - Entitlements: none needed
64
+ - First run downloads the model — 1.7 GB (Mac) / 1.7 GB (iPhone) — then it loads from the
65
+ local cache (Application Support; progress via the `downloadProgress` callback)
66
+ - Measure in Release — Debug is ~3× slower on per-token host work
67
+ <!-- gen-cards:use-it end -->
68
+
69
+ ## What it is
70
+
71
+ - **fp32, ~1.7 GB.** Output matches the torch reference (cosine 1.000012). fp32 because the
72
+ pruned SD-2.1 UNet's attention/group-norm overflow in fp16 (NaN on smooth tiles).
73
+ - **Image → image, one step.** Input a low-resolution tile, get a 4× tile back. No text, no noise.
74
+ - **456 M parameters** (pruned SD-2.1 UNet + half VAE decoder).
75
+ - The graph outputs the **raw** SR; AdcSR's per-image color-match is applied host-side by
76
+ `SuperResolver` after tiling (baking it per-tile blows up uniform tiles).
77
+
78
+ ## I/O contract (per tile)
79
+
80
+ - **input:** `lr` `[1,3,128,128]` in `[-1,1]` (a low-resolution tile).
81
+ - **output:** `sr` `[1,3,512,512]` in `[-1,1]` (×4), with the reference's per-image color-match baked in.
82
+
83
+ ## Usage (CoreAIKit)
84
+
85
+ ```swift
86
+ import CoreAIKitVision
87
+
88
+ let sr = try await SuperResolver(model: .adcsrX4) // downloads this repo on first use
89
+ let big = try await sr.upscale(cgImage) // ×4; tiles any-size input + feather-blends
90
+ ```
91
+
92
+ `SuperResolver` splits any-size input into overlapping 128-px LR windows, runs each, and blends
93
+ (and caps very large inputs so the result stays a reasonable size).
94
+
95
+ ## License & attribution
96
+
97
+ - **AdcSR** (method + the pruning/training code): Apache-2.0 — Bingchen Li et al., *Adversarial
98
+ Diffusion Compression for Real-World Image Super-Resolution*, CVPR 2025.
99
+ - **Weights** are derived from **Stable Diffusion 2.1** (via OSEDiff) and therefore carry the
100
+ **CreativeML Open RAIL++-M** license — commercial use is permitted under its use-based
101
+ restrictions, the same license under which Apple distributes Stable Diffusion for Core ML.
102
+
103
+ This Core AI conversion inherits both. See `LICENSE` (Apache-2.0, AdcSR) and the SD-2.1 OpenRAIL++-M
104
+ terms.
adcsr_x4_float32.aimodel/main.hash ADDED
@@ -0,0 +1 @@
 
 
1
+ B���n��n��
adcsr_x4_float32.aimodel/main.mlirb ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:42ccfcce6e8bbc6ec8fb0db81bbfca4e72ed4a28a0507c195ea76d9cf0ef28d0
3
+ size 1824597090
adcsr_x4_float32.aimodel/metadata.json ADDED
@@ -0,0 +1,7 @@
 
 
 
 
 
 
 
 
1
+ {
2
+ "description" : "AdcSR one-step diffusion-GAN ×4 super-resolution. lr [1,3,128,128] in [-1,1] -> sr [1,3,512,512]. Source: https:\/\/github.com\/Guaishou74851\/AdcSR (CVPR 2025).",
3
+ "author" : "Bingchen Li et al. (AdcSR, CVPR 2025)",
4
+ "assetVersion" : "2.0",
5
+ "license" : "Apache-2.0 (code); weights derived from Stable Diffusion 2.1 (CreativeML OpenRAIL++-M)",
6
+ "creationDate" : "20260623T011027Z"
7
+ }