mlboydaisuke commited on
Commit
f3d6746
Β·
verified Β·
1 Parent(s): 365d8c7

gen-cards: regenerate Use-it block

Browse files
Files changed (1) hide show
  1. README.md +7 -7
README.md CHANGED
@@ -29,7 +29,7 @@ uv run coreai.llm.export qwen3-4b --platform iOS
29
  <!-- gen-cards:use-it begin id=qwen3-4b (managed by scripts/gen-cards β€” edit cards.json / QuickStart.swift, not this block) -->
30
  ## Use it
31
 
32
- **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.
33
 
34
  ⚑ **One line** β€” this model is the default behind the kit's task op
35
  (`import CoreAIOps`; no session, no model plumbing, downloads on first use):
@@ -38,13 +38,13 @@ uv run coreai.llm.export qwen3-4b --platform iOS
38
  let tldr = try await CoreAI.summarize(text)
39
  ```
40
 
41
- Every op, one shape β€” [Cookbook](https://github.com/john-rocky/coreai-kit/blob/0.7.1/docs/COOKBOOK.md).
42
 
43
- ▢️ **Run it (source)** β€” the [ChatDemo runner](https://github.com/john-rocky/coreai-kit/tree/0.7.1/Examples/ChatDemo)
44
  (GUI + CLI, one app for every chat model in the catalog):
45
 
46
  ```bash
47
- git clone --branch 0.7.1 --depth 1 https://github.com/john-rocky/coreai-kit
48
  export DEVELOPER_DIR=/Applications/Xcode-27.0.0-RC.app/Contents/Developer
49
  open -a /Applications/Xcode-27.0.0-RC.app coreai-kit/Examples/ChatDemo/ChatDemo.xcodeproj
50
  # β†’ Run, then pick "Qwen3 4B" in the model picker
@@ -77,7 +77,7 @@ let reply = try await chat.respond(to: prompt)
77
  // reply: the answer, generated fully on-device
78
  ```
79
 
80
- The take-home is [`Examples/ChatDemo/Sources/QuickStart.swift`](https://github.com/john-rocky/coreai-kit/blob/0.7.1/Examples/ChatDemo/Sources/QuickStart.swift)
81
  β€” this exact code as one typed function, no UI; the CLI is an argument shell over it, and
82
  the GUI drives the same `ChatSession` across turns for its transcript.
83
  Multi-turn? Hold the `ChatSession` and call `respond(to:)` per turn β€” it keeps the
@@ -85,10 +85,10 @@ conversation history; `streamResponse(to:)` yields tokens as they decode.
85
 
86
  **Integration checklist**
87
 
88
- - SPM: `https://github.com/john-rocky/coreai-kit` (exact **0.7.1**) β†’ product **CoreAIKit**
89
  - Info.plist: none needed
90
  - Entitlements (iOS): `com.apple.developer.kernel.increased-memory-limit`
91
- - First run downloads the model β€” ~2,280 MB (Mac) / ~2,498 MB (iPhone) β€” then it loads from the
92
  local cache (Application Support; progress via the `downloadProgress` callback)
93
  - Measure in Release β€” Debug is ~3Γ— slower on per-token host work
94
  <!-- gen-cards:use-it end -->
 
29
  <!-- gen-cards:use-it begin id=qwen3-4b (managed by scripts/gen-cards β€” edit cards.json / QuickStart.swift, not this block) -->
30
  ## Use it
31
 
32
+ **New to Core AI? [Start with CoreAIKit 0.7.3](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.3/Examples/ChatDemo). The README records the tested OS/SDK and download size; model and device coverage is stated per example.
33
 
34
  ⚑ **One line** β€” this model is the default behind the kit's task op
35
  (`import CoreAIOps`; no session, no model plumbing, downloads on first use):
 
38
  let tldr = try await CoreAI.summarize(text)
39
  ```
40
 
41
+ Every op, one shape β€” [Cookbook](https://github.com/john-rocky/coreai-kit/blob/0.7.3/docs/COOKBOOK.md).
42
 
43
+ ▢️ **Run it (source)** β€” the [ChatDemo runner](https://github.com/john-rocky/coreai-kit/tree/0.7.3/Examples/ChatDemo)
44
  (GUI + CLI, one app for every chat model in the catalog):
45
 
46
  ```bash
47
+ git clone --branch 0.7.3 --depth 1 https://github.com/john-rocky/coreai-kit
48
  export DEVELOPER_DIR=/Applications/Xcode-27.0.0-RC.app/Contents/Developer
49
  open -a /Applications/Xcode-27.0.0-RC.app coreai-kit/Examples/ChatDemo/ChatDemo.xcodeproj
50
  # β†’ Run, then pick "Qwen3 4B" in the model picker
 
77
  // reply: the answer, generated fully on-device
78
  ```
79
 
80
+ The take-home is [`Examples/ChatDemo/Sources/QuickStart.swift`](https://github.com/john-rocky/coreai-kit/blob/0.7.3/Examples/ChatDemo/Sources/QuickStart.swift)
81
  β€” this exact code as one typed function, no UI; the CLI is an argument shell over it, and
82
  the GUI drives the same `ChatSession` across turns for its transcript.
83
  Multi-turn? Hold the `ChatSession` and call `respond(to:)` per turn β€” it keeps the
 
85
 
86
  **Integration checklist**
87
 
88
+ - SPM: `https://github.com/john-rocky/coreai-kit` (exact **0.7.3**) β†’ product **CoreAIKit**
89
  - Info.plist: none needed
90
  - Entitlements (iOS): `com.apple.developer.kernel.increased-memory-limit`
91
+ - First run downloads the model β€” ~2,279 MB (Mac) / ~2,502 MB (iPhone) β€” then it loads from the
92
  local cache (Application Support; progress via the `downloadProgress` callback)
93
  - Measure in Release β€” Debug is ~3Γ— slower on per-token host work
94
  <!-- gen-cards:use-it end -->