Pixel-Labs commited on
Commit
3a3d373
·
verified ·
1 Parent(s): a3467e5

Upload README.md

Browse files
Files changed (1) hide show
  1. mobile-android/README.md +5 -15
mobile-android/README.md CHANGED
@@ -2,11 +2,7 @@
2
 
3
  Distributed mirror for the Android app's neural TTS assets. The seven zips here are downloaded by the app at runtime — first install of a neural engine pulls only what's needed (~74 MB for one Piper voice + shared data, or ~145 MB for the full Kokoro bundle), and the user can manage each model individually from inside the app.
4
 
5
- > Sibling layout:
6
- >
7
- > - **`../extension/`** — Chrome extension models (raw HF format, published).
8
- > - **`../android/`** — local dev staging for sherpa-onnx upstream artifacts (not published).
9
- > - **`./mobile-android/` (you are here)** — the zips actually shipped to users (published to HF).
10
 
11
  ---
12
 
@@ -100,27 +96,21 @@ The native installer:
100
 
101
  ## Publishing workflow
102
 
103
- 1. **Produce the zips** from `../android/`:
104
 
105
  ```sh
106
  pnpm --filter mobile produce:neural-zips
107
  ```
108
 
109
- Writes to `packages/mobile/dist/neural-assets/`. The script reads sherpa-onnx upstream artifacts in `../android/{neural-28m,neural-82m}/` and emits the seven zips with the correct internal layouts.
110
 
111
- 2. **Copy into this folder** (for local convenience and snapshotting):
112
-
113
- ```sh
114
- cp packages/mobile/dist/neural-assets/*.zip "AI Neural Models/mobile-android/v1/"
115
- ```
116
-
117
- 3. **Upload to Hugging Face** — the user-facing primary mirror lives at:
118
 
119
  <https://huggingface.co/Pixel-Labs/threadcast-neural-models/tree/main/mobile-android/v1>
120
 
121
  Drop all seven zips into that tree. HF preserves filenames as-is. No build steps, no metadata munging — they're just static assets behind a CDN.
122
 
123
- 4. **(Optional) Mirror to a fallback host.** Same seven filenames at any HTTPS endpoint. Common picks:
124
  - Sibling HF repo (`Pixel-Labs/threadcast-neural-models-mirror/v1/...`)
125
  - GitHub Release with `gh release upload v1 dist/neural-assets/*.zip`
126
  - Private CDN (R2, S3, etc.)
 
2
 
3
  Distributed mirror for the Android app's neural TTS assets. The seven zips here are downloaded by the app at runtime — first install of a neural engine pulls only what's needed (~74 MB for one Piper voice + shared data, or ~145 MB for the full Kokoro bundle), and the user can manage each model individually from inside the app.
4
 
5
+ > Sibling: **`../extension/`** holds the Chrome extension's neural models in raw HF format. Both subtrees share the same engine families (Piper VITS, Kokoro StyleTTS2) — only the on-disk packaging differs.
 
 
 
 
6
 
7
  ---
8
 
 
96
 
97
  ## Publishing workflow
98
 
99
+ 1. **Produce the zips** from the local sherpa-onnx staging tree:
100
 
101
  ```sh
102
  pnpm --filter mobile produce:neural-zips
103
  ```
104
 
105
+ Writes to `packages/mobile/dist/neural-assets/`. The script reads the locally-staged sherpa-onnx upstream artifacts (Piper voice ONNX files + Kokoro int8 v0.19 bundle + shared espeak-ng-data) and emits the seven zips with the correct internal layouts.
106
 
107
+ 2. **Upload to Hugging Face** — the user-facing primary mirror lives at:
 
 
 
 
 
 
108
 
109
  <https://huggingface.co/Pixel-Labs/threadcast-neural-models/tree/main/mobile-android/v1>
110
 
111
  Drop all seven zips into that tree. HF preserves filenames as-is. No build steps, no metadata munging — they're just static assets behind a CDN.
112
 
113
+ 3. **(Optional) Mirror to a fallback host.** Same seven filenames at any HTTPS endpoint. Common picks:
114
  - Sibling HF repo (`Pixel-Labs/threadcast-neural-models-mirror/v1/...`)
115
  - GitHub Release with `gh release upload v1 dist/neural-assets/*.zip`
116
  - Private CDN (R2, S3, etc.)