mlboydaisuke commited on
Commit
c08e670
Β·
verified Β·
1 Parent(s): efe025e

gen-cards: regenerate Use-it block

Browse files
Files changed (1) hide show
  1. README.md +13 -8
README.md CHANGED
@@ -30,6 +30,8 @@ no prompt, no noise β€” so it is fast and small enough to run fully on-device, i
30
  <!-- gen-cards:use-it begin id=adcsr-x4 (managed by scripts/gen-cards β€” edit cards.json / QuickStart.swift, not this block) -->
31
  ## Use it
32
 
 
 
33
  ⚑ **One line** β€” this model is the default behind the kit's task op
34
  (`import CoreAIOps`; no session, no model plumbing, downloads on first use):
35
 
@@ -37,21 +39,24 @@ no prompt, no noise β€” so it is fast and small enough to run fully on-device, i
37
  let big = try await CoreAI.upscale(image)
38
  ```
39
 
40
- Every op, one shape β€” [Cookbook](https://github.com/john-rocky/coreai-kit/blob/main/docs/COOKBOOK.md).
41
 
42
- ▢️ **Run it (source)** β€” the [UpscaleDemo runner](https://github.com/john-rocky/coreai-kit/tree/main/Examples/UpscaleDemo)
43
  (pick a photo, upscale it Γ—4 on-device):
44
 
45
  ```bash
46
- git clone https://github.com/john-rocky/coreai-kit
47
- open coreai-kit/Examples/UpscaleDemo/UpscaleDemo.xcodeproj
 
48
  # β†’ Run, pick a photo β€” the app loads AdcSR Γ—4 (the catalog's superResolution entry) automatically
49
 
50
  # agents / headless (macOS):
51
  cd coreai-kit/Examples/UpscaleDemo
52
- swift run upscale-cli --model adcsr-x4 --image sample_small.png --output big.png
53
  ```
54
 
 
 
55
  πŸ’» **Build with it** β€” complete; the glue is kit API, copy-paste runs:
56
 
57
  ```swift
@@ -63,7 +68,7 @@ let upscaled = try await resolver.upscale(image.cgImage)
63
  // upscaled: CGImage β€” 4Γ— the input's pixels
64
  ```
65
 
66
- The take-home is [`Examples/UpscaleDemo/Sources/QuickStart.swift`](https://github.com/john-rocky/coreai-kit/blob/main/Examples/UpscaleDemo/Sources/QuickStart.swift)
67
  β€” this exact code as one typed function, no UI; the CLI is an argument shell over it, and
68
  the GUI runs the same resolver on the photo you pick.
69
  Big photos? Inputs are tiled and feather-blended internally; `maxInputSide` (default 512)
@@ -71,10 +76,10 @@ caps the input first so a full-res phone photo can't produce a gigapixel result.
71
 
72
  **Integration checklist**
73
 
74
- - SPM: `https://github.com/john-rocky/coreai-kit` β†’ product **CoreAIKitVision**
75
  - Info.plist: none needed
76
  - Entitlements: none needed
77
- - First run downloads the model β€” 1.7 GB (Mac) / 1.7 GB (iPhone) β€” then it loads from the
78
  local cache (Application Support; progress via the `downloadProgress` callback)
79
  - Measure in Release β€” Debug is ~3Γ— slower on per-token host work
80
  <!-- gen-cards:use-it end -->
 
30
  <!-- gen-cards:use-it begin id=adcsr-x4 (managed by scripts/gen-cards β€” edit cards.json / QuickStart.swift, not this block) -->
31
  ## Use it
32
 
33
+ **New to Core AI? [Start with CoreAIKit 0.7.1](https://github.com/john-rocky/coreai-kit#readme).** Follow its requirements and first-run steps for `qwen3-0.6b`, then open the same release's [ChatDemo](https://github.com/john-rocky/coreai-kit/tree/0.7.1/Examples/ChatDemo). The README records the tested OS/SDK and download size; model and device coverage is stated per example.
34
+
35
  ⚑ **One line** β€” this model is the default behind the kit's task op
36
  (`import CoreAIOps`; no session, no model plumbing, downloads on first use):
37
 
 
39
  let big = try await CoreAI.upscale(image)
40
  ```
41
 
42
+ Every op, one shape β€” [Cookbook](https://github.com/john-rocky/coreai-kit/blob/0.7.1/docs/COOKBOOK.md).
43
 
44
+ ▢️ **Run it (source)** β€” the [UpscaleDemo runner](https://github.com/john-rocky/coreai-kit/tree/0.7.1/Examples/UpscaleDemo)
45
  (pick a photo, upscale it Γ—4 on-device):
46
 
47
  ```bash
48
+ git clone --branch 0.7.1 --depth 1 https://github.com/john-rocky/coreai-kit
49
+ export DEVELOPER_DIR=/Applications/Xcode-27.0.0-RC.app/Contents/Developer
50
+ open -a /Applications/Xcode-27.0.0-RC.app coreai-kit/Examples/UpscaleDemo/UpscaleDemo.xcodeproj
51
  # β†’ Run, pick a photo β€” the app loads AdcSR Γ—4 (the catalog's superResolution entry) automatically
52
 
53
  # agents / headless (macOS):
54
  cd coreai-kit/Examples/UpscaleDemo
55
+ swift run -c release upscale-cli --model adcsr-x4 --image sample_small.png --output big.png
56
  ```
57
 
58
+ Use Xcode build **27A266a** from the release's `.xcode-pin`; adjust the app path if your installation is named differently.
59
+
60
  πŸ’» **Build with it** β€” complete; the glue is kit API, copy-paste runs:
61
 
62
  ```swift
 
68
  // upscaled: CGImage β€” 4Γ— the input's pixels
69
  ```
70
 
71
+ The take-home is [`Examples/UpscaleDemo/Sources/QuickStart.swift`](https://github.com/john-rocky/coreai-kit/blob/0.7.1/Examples/UpscaleDemo/Sources/QuickStart.swift)
72
  β€” this exact code as one typed function, no UI; the CLI is an argument shell over it, and
73
  the GUI runs the same resolver on the photo you pick.
74
  Big photos? Inputs are tiled and feather-blended internally; `maxInputSide` (default 512)
 
76
 
77
  **Integration checklist**
78
 
79
+ - SPM: `https://github.com/john-rocky/coreai-kit` (exact **0.7.1**) β†’ product **CoreAIKitVision**
80
  - Info.plist: none needed
81
  - Entitlements: none needed
82
+ - First run downloads the model β€” ~1,740 MB (Mac) / ~1,740 MB (iPhone) β€” then it loads from the
83
  local cache (Application Support; progress via the `downloadProgress` callback)
84
  - Measure in Release β€” Debug is ~3Γ— slower on per-token host work
85
  <!-- gen-cards:use-it end -->