Mirror AutoDroid pins from coreai-community/Kokoro-82M-CoreAI@412414ca12d7

AUTODROID_MIRROR.md

@@ -0,0 +1,7 @@
+# AutoDroid artifact mirror
+
+This repository preserves selected, unmodified files from `coreai-community/Kokoro-82M-CoreAI` at commit `412414ca12d72aa68d3cef0fee70147e87c32f28`.
+
+Original authorship, licenses, and notices remain applicable. This is an independent availability mirror and does not imply upstream endorsement.
+
+See `AUTODROID_SOURCE.json` for original paths, byte sizes, and SHA-256 digests. Only files required by AutoDroid and upstream documentation are included; this is not a complete training or Transformers checkpoint.

AUTODROID_SOURCE.json

@@ -0,0 +1,41 @@
+{
+  "sourceRepository": "coreai-community/Kokoro-82M-CoreAI",
+  "sourceRevision": "412414ca12d72aa68d3cef0fee70147e87c32f28",
+  "purpose": "Unmodified pinned artifacts used by AutoDroid",
+  "licenseReview": {
+    "sourceRevision": "412414ca12d72aa68d3cef0fee70147e87c32f28",
+    "declaredLicense": "apache-2.0",
+    "evidence": "https://huggingface.co/coreai-community/Kokoro-82M-CoreAI/blob/412414ca12d72aa68d3cef0fee70147e87c32f28/README.md",
+    "status": "approved",
+    "reason": "Pinned upstream card permits redistribution. Preserve upstream cards and notices, original authorship, and the applicable license texts; artifact bytes are unmodified.",
+    "additionalFiles": [
+      {
+        "localPath": "tools/hf_mirror/licenses/Apache-2.0.txt",
+        "pathInRepo": "licenses/Apache-2.0.txt",
+        "source": "https://www.apache.org/licenses/LICENSE-2.0.txt",
+        "sha256": "c98068a3b6a564e4c70ab7c2ee2c980725987908909e99915759efa28ac7b533"
+      }
+    ]
+  },
+  "artifacts": [
+    {
+      "repo": "coreai-community/Kokoro-82M-CoreAI",
+      "revision": "412414ca12d72aa68d3cef0fee70147e87c32f28",
+      "filename": "kokoro_host_glue/l_linear.bin",
+      "sizeBytes": 40,
+      "sha256": "4d0be6c9712b1627889fdf7bdcd342d61c1f8a4b6c3ee356709ef3748f33d425",
+      "source": "app/src/main/java/com/example/autodroid/data/voice/model/VoiceModelCatalog.kt:375"
+    },
+    {
+      "repo": "coreai-community/Kokoro-82M-CoreAI",
+      "revision": "412414ca12d72aa68d3cef0fee70147e87c32f28",
+      "filename": "kokoro_host_glue/voices/af_heart.bin",
+      "sizeBytes": 522240,
+      "sha256": "d583ccff3cdca2f7fae535cb998ac07e9fcb90f09737b9a41fa2734ec44a8f0b",
+      "source": "app/src/main/java/com/example/autodroid/data/voice/model/VoiceModelCatalog.kt:383"
+    }
+  ],
+  "preservedDocuments": [
+    "README.md"
+  ]
+}

README.md

@@ -0,0 +1,126 @@
+---
+license: apache-2.0
+language:
+- en
+library_name: coreai
+pipeline_tag: text-to-speech
+tags:
+- text-to-speech
+- tts
+- core-ai
+- coreml
+- on-device
+- styletts2
+- kokoro
+base_model: hexgrad/Kokoro-82M
+---
+
+> **Mirror** of [`mlboydaisuke/Kokoro-82M-CoreAI`](https://huggingface.co/mlboydaisuke/Kokoro-82M-CoreAI) — the canonical repo ([CoreAI Model Zoo](https://github.com/john-rocky/coreai-model-zoo)). Updates land there first.
+
+
+# Kokoro-82M — Core AI
+
+[`hexgrad/Kokoro-82M`](https://huggingface.co/hexgrad/Kokoro-82M) (Apache-2.0), a tiny
+high-quality **StyleTTS2 + iSTFTNet** text-to-speech model (82M params, 24 kHz),
+converted to Apple **Core AI** (`.aimodel`, iOS 27 / macOS 27) — the
+[CoreAI-Model-Zoo](https://github.com/john-rocky/coreai-model-zoo)'s first TTS.
+
+Non-autoregressive: phonemes + a voice/style vector → a waveform in one pass.
+Runs fully on-device, English-first, with grapheme→phoneme on the host.
+
+<!-- gen-cards:use-it begin id=kokoro-82m (managed by scripts/gen-cards — edit cards.json / QuickStart.swift, not this block) -->
+## Use it
+
+▶️ **Run it (source)** — the [Speak runner](https://github.com/john-rocky/coreai-kit/tree/main/Examples/Speak)
+(GUI + CLI, one app for every text-to-speech model in the catalog):
+
+```bash
+git clone https://github.com/john-rocky/coreai-kit
+open coreai-kit/Examples/Speak/Speak.xcodeproj
+# → Run, then pick "Kokoro 82M" in the model picker
+
+# agents / headless (macOS):
+cd coreai-kit/Examples/Speak
+swift run speak-cli --model kokoro-82m --text "Hello from Core AI." --output hello.wav
+```
+
+💻 **Build with it** — complete; the glue is kit API, copy-paste runs:
+
+```swift
+import CoreAIKit
+
+let speaker = try await KitSpeaker(catalog: "kokoro-82m")
+let audio = try await speaker.synthesize(text)
+// audio.samples: 24 kHz mono PCM in [-1, 1] — play it or write a WAV
+```
+
+The take-home is [`Examples/Speak/Sources/QuickStart.swift`](https://github.com/john-rocky/coreai-kit/blob/main/Examples/Speak/Sources/QuickStart.swift)
+— this exact code as one typed function, no UI; the CLI is an argument shell over it, and
+the GUI drives the same `KitSpeaker(catalog:)` and plays the samples.
+English-first: G2P is a dictionary over the bundled misaki lexicons (~180k words);
+out-of-dictionary words are letter-spelled (no neural fallback). 28 voices ride the
+download — `af_heart` is the default; the underlying `KokoroTTS` takes a `voice:`
+label. Streaming? `synthesizeStreaming(_:onChunk:)` hands you a chunk per sentence.
+
+**Integration checklist**
+
+- SPM: `https://github.com/john-rocky/coreai-kit` → product **CoreAIKit**
+- Info.plist: none needed
+- Entitlements: none needed
+- First run downloads the model — 0.3 GB (Mac) — then it loads from the
+  local cache (Application Support; progress via the `downloadProgress` callback)
+- Measure in Release — Debug is ~3× slower on per-token host work
+<!-- gen-cards:use-it end -->
+
+## Bundles
+
+The acoustic graph has one data-dependent length (the duration→alignment expansion),
+so it is cut into **three voice-independent `.aimodel` bundles** with two cheap host
+steps between them:
+
+| file | in → out |
+|---|---|
+| `kokoro_predictor.aimodel` | `input_ids[1,128]` i32, `ref_s[1,256]`, `attn_mask[1,128]` → `duration`, `d`, `t_en` |
+| `kokoro_prosody.aimodel` | `d`, `t_en`, `aln[1,128,512]`, `ref_s`, `frame_mask[1,512]` → `asr`, `F0`, `N` |
+| `kokoro_vocoder.aimodel` | `asr`, `F0`, `N`, `har`, `ref_s`, `frame_mask` → `audio[1, L·600]` |
+
+`voices/*.pt` — the **28 English voice packs** (Apache-2.0). The voice is the `ref_s`
+input: `ref_s = pack[len(ids)−1]`. Quality leaders: `af_heart`, `af_bella`,
+`af_nicole`, `bf_emma`.
+
+Token length **T** and frame length **L** are fixed **buckets** (128 / 512); the host
+left-pads to the bucket and trims the output. Longer text is split into sentences
+host-side. Run on the Core AI **CPU** compute unit. ~0.75 s / utterance on M4 Max,
+~335 MB total (fp32).
+
+## Host steps
+
+```
+text ──(misaki G2P)──▶ ids ──▶ predictor ──▶ [build alignment] ──▶ prosody
+     ──▶ [har = STFT(SineGen(f0_upsamp(F0)))] ──▶ vocoder ──▶ [trim] ──▶ 24 kHz audio
+```
+
+G2P is [misaki](https://github.com/hexgrad/misaki) (`misaki[en]`, no espeak for
+English); on-device [MisakiSwift](https://github.com/mlalma/MisakiSwift) gives the same
+English phonemes. `har` (the hn-nsf source's STFT) is a windowed FFT computed on the
+host — the one piece that must stay off the engine (its `atan2` phase flips 2π at the
+F0→0 pad boundary under fp32).
+
+## Quality
+
+The hn-nsf source phase is arbitrary (stock Kokoro randomizes it), so the gate is
+spectral: **magnitude-spectrogram correlation 0.999** vs the PyTorch reference
+(`af_heart`, multiple sentences). Raw waveform correlation ~0.98 — the bounded,
+inaudible effect of the bucket pad boundary.
+
+## Convert / re-bucket
+
+[`conversion/export_kokoro.py`](https://github.com/john-rocky/coreai-model-zoo/blob/main/conversion/export_kokoro.py)
+(`python export_kokoro.py --out-dir out`; `--verify` runs the engine-vs-torch spectral
+gate; `--token-bucket` / `--frame-bucket` to re-size). Card + the full port write-up:
+[`zoo/kokoro-82m.md`](https://github.com/john-rocky/coreai-model-zoo/blob/main/zoo/kokoro-82m.md).
+
+## License
+
+Apache-2.0 (model weights and the 28 English voices). The Core AI export code derives
+from Apple's BSD-3-Clause `coreai_models`.

kokoro_host_glue/l_linear.bin

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:4d0be6c9712b1627889fdf7bdcd342d61c1f8a4b6c3ee356709ef3748f33d425
+size 40

kokoro_host_glue/voices/af_heart.bin

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:d583ccff3cdca2f7fae535cb998ac07e9fcb90f09737b9a41fa2734ec44a8f0b
+size 522240

licenses/Apache-2.0.txt

@@ -0,0 +1,171 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and
+distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the
+copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other
+entities that control, are controlled by, or are under common control with
+that entity. For the purposes of this definition, "control" means (i) the
+power, direct or indirect, to cause the direction or management of such
+entity, whether by contract or otherwise, or (ii) ownership of fifty percent
+(50%) or more of the outstanding shares, or (iii) beneficial ownership of
+such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising
+permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications,
+including but not limited to software source code, documentation source, and
+configuration files.
+
+"Object" form shall mean any form resulting from mechanical transformation
+or translation of a Source form, including but not limited to compiled object
+code, generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form,
+made available under the License, as indicated by a copyright notice that is
+included in or attached to the work.
+
+"Derivative Works" shall mean any work, whether in Source or Object form,
+that is based on (or derived from) the Work and for which the editorial
+revisions, annotations, elaborations, or other modifications represent, as a
+whole, an original work of authorship. Derivative Works shall not include
+works that remain separable from, or merely link (or bind by name) to the
+interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original
+version of the Work and any modifications or additions to that Work or
+Derivative Works thereof, that is intentionally submitted to Licensor for
+inclusion in the Work by the copyright owner or by an individual or Legal
+Entity authorized to submit on behalf of the copyright owner. "Submitted"
+means any form of electronic, verbal, or written communication sent to the
+Licensor or its representatives, excluding communication conspicuously marked
+or otherwise designated in writing by the copyright owner as "Not a
+Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on
+behalf of whom a Contribution has been received by Licensor and subsequently
+incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of this
+License, each Contributor hereby grants to You a perpetual, worldwide,
+non-exclusive, no-charge, royalty-free, irrevocable copyright license to
+reproduce, prepare Derivative Works of, publicly display, publicly perform,
+sublicense, and distribute the Work and such Derivative Works in Source or
+Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of this
+License, each Contributor hereby grants to You a perpetual, worldwide,
+non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this
+section) patent license to make, have made, use, offer to sell, sell, import,
+and otherwise transfer the Work, where such license applies only to those
+patent claims licensable by such Contributor that are necessarily infringed
+by their Contribution(s) alone or by combination of their Contribution(s)
+with the Work to which such Contribution(s) was submitted. If You institute
+patent litigation against any entity alleging that the Work or a Contribution
+incorporated within the Work constitutes direct or contributory patent
+infringement, then any patent licenses granted to You under this License for
+that Work shall terminate as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the Work or
+Derivative Works thereof in any medium, with or without modifications, and in
+Source or Object form, provided that You meet the following conditions:
+
+(a) You must give any other recipients of the Work or Derivative Works a copy
+of this License; and
+
+(b) You must cause any modified files to carry prominent notices stating that
+You changed the files; and
+
+(c) You must retain, in the Source form of any Derivative Works that You
+distribute, all copyright, patent, trademark, and attribution notices from the
+Source form of the Work, excluding those notices that do not pertain to any
+part of the Derivative Works; and
+
+(d) If the Work includes a "NOTICE" text file as part of its distribution,
+then any Derivative Works that You distribute must include a readable copy of
+the attribution notices contained within such NOTICE file, excluding those
+notices that do not pertain to any part of the Derivative Works, in at least
+one of the following places: within a NOTICE text file distributed as part of
+the Derivative Works; within the Source form or documentation, if provided;
+or, within a display generated by the Derivative Works, if and wherever such
+third-party notices normally appear. The contents of the NOTICE file are for
+informational purposes only and do not modify the License.
+
+You may add Your own copyright statement to Your modifications and may
+provide additional or different license terms and conditions for use,
+reproduction, or distribution of Your modifications, provided that Your use,
+reproduction, and distribution of the Work otherwise complies with the
+conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise, any
+Contribution intentionally submitted for inclusion in the Work by You to the
+Licensor shall be under the terms and conditions of this License, without any
+additional terms or conditions.
+
+6. Trademarks. This License does not grant permission to use the trade names,
+trademarks, service marks, or product names of the Licensor, except as
+required for reasonable and customary use in describing the origin of the
+Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or agreed to in
+writing, Licensor provides the Work (and each Contributor provides its
+Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied, including, without limitation, any warranties
+or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+PARTICULAR PURPOSE. You are solely responsible for determining the
+appropriateness of using or redistributing the Work and assume any risks
+associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory, whether in
+tort (including negligence), contract, or otherwise, unless required by
+applicable law (such as deliberate and grossly negligent acts) or agreed to in
+writing, shall any Contributor be liable to You for damages, including any
+direct, indirect, special, incidental, or consequential damages arising as a
+result of this License or out of the use or inability to use the Work, even if
+such Contributor has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing the Work
+or Derivative Works thereof, You may choose to offer, and charge a fee for,
+acceptance of support, warranty, indemnity, or other liability obligations
+and/or rights consistent with this License. However, in accepting such
+obligations, You may act only on Your own behalf and on Your sole
+responsibility, not on behalf of any other Contributor, and only if You agree
+to indemnify, defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason of your
+accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+To apply the Apache License to your work, attach the following boilerplate
+notice, with the fields enclosed by brackets "[]" replaced with your own
+identifying information. (Don't include the brackets!) The text should be
+enclosed in the appropriate comment syntax for the file format. We also
+recommend that a file or class name and description of purpose be included on
+the same "printed page" as the copyright notice for easier identification
+within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.