Shusek00 commited on
Commit
d0ad239
·
verified ·
1 Parent(s): 8026061

Correct recommended revision for prebuilt frontends v2.1.1

Browse files
README.md CHANGED
@@ -30,7 +30,7 @@ tags:
30
  # Complete Kokoro catalog for ONNX Runtime and Kotlin Multiplatform
31
 
32
  All 157 voices published in the pinned official Kokoro v1.0 and v1.1-zh repositories, plus the
33
- native Polish and German voices, converted for on-device ONNX Runtime use. Version 2.1.0 contains
34
  **159 voices**, **10 languages / 11 locale profiles**, and **4 compatible FP32 models**.
35
 
36
  The catalog is designed for a language picker followed by a voice picker. A client downloads only
@@ -59,7 +59,7 @@ voices introduced with v1.1-zh are included as well and correctly point to that
59
 
60
  ## Download-on-demand client flow
61
 
62
- 1. Fetch [`catalog.json`](catalog.json) from the immutable `v2.1.0` revision.
63
  2. Show `languages`, then the selected language's `voices`.
64
  3. Read the selected voice's `modelId` and resolve it in top-level `models`.
65
  4. Resolve that model's `tokenizerId` in top-level `tokenizers`.
@@ -68,7 +68,7 @@ voices introduced with v1.1-zh are included as well and correctly point to that
68
  6. Verify each file's `sizeBytes` and `sha256` before activating it.
69
  7. Cache by artifact path or SHA-256 so shared models are not downloaded again.
70
 
71
- Resolve every artifact path relative to the catalog URL. Pinning the catalog to `v2.1.0` therefore
72
  pins every dependent file to the same immutable release. The schema is versioned at
73
  [`schema/kokoro-catalog.schema.json`](schema/kokoro-catalog.schema.json).
74
 
@@ -95,7 +95,7 @@ combining marks such as the nasalization mark in `ɔ̃` are separate code points
95
  ## Text frontends
96
 
97
  Phonemis assets are bundled for `en-us`, `en-gb`, `de`, `fr`, `es`, `it`, `pl`, `pt`, and `hi`.
98
- Version 2.1.0 publishes each neural frontend as a ready-to-open ONNX graph, so clients no longer
99
  need to convert the upstream weight container at runtime. They produce Kokoro-compatible IPA
100
  without shipping eSpeak or a GPL component. English packs also include the full lexicon and
101
  part-of-speech tagger required for best results.
@@ -110,7 +110,7 @@ distributed here.
110
 
111
  ## Validation
112
 
113
- Version 2.1.0 preserves the complete 2.0.0 validation baseline and additionally validates all nine
114
  prebuilt Phonemis graphs with ONNX Runtime 1.29 CPU inference. Validation covers:
115
 
116
  - JSON Schema and SHA-256 verification for all 183 catalog artifacts;
@@ -148,7 +148,7 @@ fixed voice-count assertions. Source and converted hashes are recorded in
148
  Maintainers can publish a fully validated folder after authenticating with the Hugging Face CLI:
149
 
150
  ```bash
151
- python scripts/publish_hf.py <namespace>/kokoro-kmp-models --tag v2.1.0
152
  ```
153
 
154
  ## Scope and compatibility
 
30
  # Complete Kokoro catalog for ONNX Runtime and Kotlin Multiplatform
31
 
32
  All 157 voices published in the pinned official Kokoro v1.0 and v1.1-zh repositories, plus the
33
+ native Polish and German voices, converted for on-device ONNX Runtime use. Version 2.1.1 contains
34
  **159 voices**, **10 languages / 11 locale profiles**, and **4 compatible FP32 models**.
35
 
36
  The catalog is designed for a language picker followed by a voice picker. A client downloads only
 
59
 
60
  ## Download-on-demand client flow
61
 
62
+ 1. Fetch [`catalog.json`](catalog.json) from the immutable `v2.1.1` revision.
63
  2. Show `languages`, then the selected language's `voices`.
64
  3. Read the selected voice's `modelId` and resolve it in top-level `models`.
65
  4. Resolve that model's `tokenizerId` in top-level `tokenizers`.
 
68
  6. Verify each file's `sizeBytes` and `sha256` before activating it.
69
  7. Cache by artifact path or SHA-256 so shared models are not downloaded again.
70
 
71
+ Resolve every artifact path relative to the catalog URL. Pinning the catalog to `v2.1.1` therefore
72
  pins every dependent file to the same immutable release. The schema is versioned at
73
  [`schema/kokoro-catalog.schema.json`](schema/kokoro-catalog.schema.json).
74
 
 
95
  ## Text frontends
96
 
97
  Phonemis assets are bundled for `en-us`, `en-gb`, `de`, `fr`, `es`, `it`, `pl`, `pt`, and `hi`.
98
+ Version 2.1.1 publishes each neural frontend as a ready-to-open ONNX graph, so clients no longer
99
  need to convert the upstream weight container at runtime. They produce Kokoro-compatible IPA
100
  without shipping eSpeak or a GPL component. English packs also include the full lexicon and
101
  part-of-speech tagger required for best results.
 
110
 
111
  ## Validation
112
 
113
+ Version 2.1.1 preserves the complete 2.0.0 validation baseline and additionally validates all nine
114
  prebuilt Phonemis graphs with ONNX Runtime 1.29 CPU inference. Validation covers:
115
 
116
  - JSON Schema and SHA-256 verification for all 183 catalog artifacts;
 
148
  Maintainers can publish a fully validated folder after authenticating with the Hugging Face CLI:
149
 
150
  ```bash
151
+ python scripts/publish_hf.py <namespace>/kokoro-kmp-models --tag v2.1.1
152
  ```
153
 
154
  ## Scope and compatibility
catalog.json CHANGED
@@ -1,12 +1,12 @@
1
  {
2
  "$schema": "schema/kokoro-catalog.schema.json",
3
  "schemaVersion": 2,
4
- "catalogVersion": "2.1.0",
5
  "distribution": {
6
  "provider": "huggingface",
7
  "repository": "Shusek00/kokoro-kmp-models",
8
  "artifactResolution": "relative-to-catalog",
9
- "recommendedRevision": "v2.0.0",
10
  "downloadStrategy": "selected-voice-only"
11
  },
12
  "license": "Apache-2.0",
 
1
  {
2
  "$schema": "schema/kokoro-catalog.schema.json",
3
  "schemaVersion": 2,
4
+ "catalogVersion": "2.1.1",
5
  "distribution": {
6
  "provider": "huggingface",
7
  "repository": "Shusek00/kokoro-kmp-models",
8
  "artifactResolution": "relative-to-catalog",
9
+ "recommendedRevision": "v2.1.1",
10
  "downloadStrategy": "selected-voice-only"
11
  },
12
  "license": "Apache-2.0",
catalog.template.json CHANGED
@@ -1,12 +1,12 @@
1
  {
2
  "$schema": "schema/kokoro-catalog.schema.json",
3
  "schemaVersion": 2,
4
- "catalogVersion": "2.1.0",
5
  "distribution": {
6
  "provider": "huggingface",
7
  "repository": "Shusek00/kokoro-kmp-models",
8
  "artifactResolution": "relative-to-catalog",
9
- "recommendedRevision": "v2.0.0",
10
  "downloadStrategy": "selected-voice-only"
11
  },
12
  "license": "Apache-2.0",
 
1
  {
2
  "$schema": "schema/kokoro-catalog.schema.json",
3
  "schemaVersion": 2,
4
+ "catalogVersion": "2.1.1",
5
  "distribution": {
6
  "provider": "huggingface",
7
  "repository": "Shusek00/kokoro-kmp-models",
8
  "artifactResolution": "relative-to-catalog",
9
+ "recommendedRevision": "v2.1.1",
10
  "downloadStrategy": "selected-voice-only"
11
  },
12
  "license": "Apache-2.0",
scripts/publish_hf.py CHANGED
@@ -25,7 +25,7 @@ def run_validation(skip_web: bool) -> None:
25
  def parse_args() -> argparse.Namespace:
26
  parser = argparse.ArgumentParser()
27
  parser.add_argument("repo_id", help="Hugging Face repo, e.g. username/kokoro-kmp-models")
28
- parser.add_argument("--tag", default="v2.1.0")
29
  parser.add_argument("--skip-web-validation", action="store_true")
30
  return parser.parse_args()
31
 
 
25
  def parse_args() -> argparse.Namespace:
26
  parser = argparse.ArgumentParser()
27
  parser.add_argument("repo_id", help="Hugging Face repo, e.g. username/kokoro-kmp-models")
28
+ parser.add_argument("--tag", default="v2.1.1")
29
  parser.add_argument("--skip-web-validation", action="store_true")
30
  return parser.parse_args()
31
 
validation/package-validation.json CHANGED
@@ -1,5 +1,5 @@
1
  {
2
- "catalogVersion": "2.1.0",
3
  "catalogSchemaValidated": true,
4
  "onnxRuntimeVersion": "1.29.0",
5
  "artifactsVerified": 183,
 
1
  {
2
+ "catalogVersion": "2.1.1",
3
  "catalogSchemaValidated": true,
4
  "onnxRuntimeVersion": "1.29.0",
5
  "artifactsVerified": 183,