mlboydaisuke commited on
Commit
932a895
Β·
verified Β·
1 Parent(s): ba0d2ad

gen-cards: regenerate Use-it block

Browse files
Files changed (1) hide show
  1. README.md +13 -8
README.md CHANGED
@@ -43,6 +43,8 @@ device.
43
  <!-- gen-cards:use-it begin id=s1-mini (managed by scripts/gen-cards β€” edit cards.json / QuickStart.swift, not this block) -->
44
  ## Use it
45
 
 
 
46
  ⚑ **One line** β€” this model is the default behind the kit's task op
47
  (`import CoreAIOps`; no session, no model plumbing, downloads on first use):
48
 
@@ -50,21 +52,24 @@ device.
50
  let clean = try await CoreAI.tidyTranscript(rawTranscript)
51
  ```
52
 
53
- Every op, one shape β€” [Cookbook](https://github.com/john-rocky/coreai-kit/blob/main/docs/COOKBOOK.md).
54
 
55
- ▢️ **Run it (source)** β€” the [Tidy runner](https://github.com/john-rocky/coreai-kit/tree/main/Examples/Tidy)
56
  (GUI + CLI, the three control axes as pickers):
57
 
58
  ```bash
59
- git clone https://github.com/john-rocky/coreai-kit
60
- open coreai-kit/Examples/Tidy/Tidy.xcodeproj
 
61
  # β†’ Run, then pick "S1-mini by Superwhisper" in the model picker
62
 
63
  # agents / headless (macOS):
64
  cd coreai-kit/Examples/Tidy
65
- swift run tidy-cli --model s1-mini --text "so um i need to like send the the report by uh friday no wait make that thursday"
66
  ```
67
 
 
 
68
  πŸ’» **Build with it** β€” complete; the glue is kit API, copy-paste runs:
69
 
70
  ```swift
@@ -78,17 +83,17 @@ let result = try await tidier.normalize(transcript)
78
  // result: the transcript as written text β€” English only; filler-only input returns ""
79
  ```
80
 
81
- The take-home is [`Examples/Tidy/Sources/QuickStart.swift`](https://github.com/john-rocky/coreai-kit/blob/main/Examples/Tidy/Sources/QuickStart.swift)
82
  β€” this exact code as one typed function, no UI; both the runner's GUI and its CLI call it.
83
  Cleaning transcripts repeatedly? Keep the `KitTextNormalizer` loaded and call
84
  `normalize(_:)` per transcript β€” the 796 MB load is what you are avoiding.
85
 
86
  **Integration checklist**
87
 
88
- - SPM: `https://github.com/john-rocky/coreai-kit` β†’ product **CoreAIKit**
89
  - Info.plist: none needed
90
  - Entitlements: none needed
91
- - First run downloads the model β€” 0.8 GB (Mac) / 0.8 GB (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 -->
 
43
  <!-- gen-cards:use-it begin id=s1-mini (managed by scripts/gen-cards β€” edit cards.json / QuickStart.swift, not this block) -->
44
  ## Use it
45
 
46
+ **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.
47
+
48
  ⚑ **One line** β€” this model is the default behind the kit's task op
49
  (`import CoreAIOps`; no session, no model plumbing, downloads on first use):
50
 
 
52
  let clean = try await CoreAI.tidyTranscript(rawTranscript)
53
  ```
54
 
55
+ Every op, one shape β€” [Cookbook](https://github.com/john-rocky/coreai-kit/blob/0.7.1/docs/COOKBOOK.md).
56
 
57
+ ▢️ **Run it (source)** β€” the [Tidy runner](https://github.com/john-rocky/coreai-kit/tree/0.7.1/Examples/Tidy)
58
  (GUI + CLI, the three control axes as pickers):
59
 
60
  ```bash
61
+ git clone --branch 0.7.1 --depth 1 https://github.com/john-rocky/coreai-kit
62
+ export DEVELOPER_DIR=/Applications/Xcode-27.0.0-RC.app/Contents/Developer
63
+ open -a /Applications/Xcode-27.0.0-RC.app coreai-kit/Examples/Tidy/Tidy.xcodeproj
64
  # β†’ Run, then pick "S1-mini by Superwhisper" in the model picker
65
 
66
  # agents / headless (macOS):
67
  cd coreai-kit/Examples/Tidy
68
+ swift run -c release tidy-cli --model s1-mini --text "so um i need to like send the the report by uh friday no wait make that thursday"
69
  ```
70
 
71
+ Use Xcode build **27A266a** from the release's `.xcode-pin`; adjust the app path if your installation is named differently.
72
+
73
  πŸ’» **Build with it** β€” complete; the glue is kit API, copy-paste runs:
74
 
75
  ```swift
 
83
  // result: the transcript as written text β€” English only; filler-only input returns ""
84
  ```
85
 
86
+ The take-home is [`Examples/Tidy/Sources/QuickStart.swift`](https://github.com/john-rocky/coreai-kit/blob/0.7.1/Examples/Tidy/Sources/QuickStart.swift)
87
  β€” this exact code as one typed function, no UI; both the runner's GUI and its CLI call it.
88
  Cleaning transcripts repeatedly? Keep the `KitTextNormalizer` loaded and call
89
  `normalize(_:)` per transcript β€” the 796 MB load is what you are avoiding.
90
 
91
  **Integration checklist**
92
 
93
+ - SPM: `https://github.com/john-rocky/coreai-kit` (exact **0.7.1**) β†’ product **CoreAIKit**
94
  - Info.plist: none needed
95
  - Entitlements: none needed
96
+ - First run downloads the model β€” ~796 MB (Mac) / ~796 MB (iPhone) β€” then it loads from the
97
  local cache (Application Support; progress via the `downloadProgress` callback)
98
  - Measure in Release β€” Debug is ~3Γ— slower on per-token host work
99
  <!-- gen-cards:use-it end -->