Update usage documentation

README.en.md

@@ -1,49 +1,36 @@
----
-license: cc-by-sa-4.0
-language: ja
-tags: [coreml, style-bert-vits2]
-base_model: ku-nlp/deberta-v2-large-japanese-char-wwm
----
-# SBV2 Core ML shared Japanese resources
-
-[日本語（メイン）](README.md)
-
-Shared BERT for the SBV2CoreML Swift library, iOS 18+ / macOS 15+ Apple Silicon.
-Download once and reuse across compatible JP-Extra voices. This package also
-contains the Open JTalk 1.11 UTF-8 dictionary under its separate BSD notices.
-
-## Model repositories
-
-This package: [AILogDev/sbv2-coreml-common](https://huggingface.co/AILogDev/sbv2-coreml-common).
-Required companion: [AILogDev/sbv2-coreml-jvnv-f1-jp](https://huggingface.co/AILogDev/sbv2-coreml-jvnv-f1-jp).
-Download the complete repository contents, preserving all `.mlpackage` folders.
-Use a pinned commit revision for reproducible downloads.
-Private repositories require an authenticated Hugging Face client; download them
-locally and select that folder. The sample's HTTPS downloader does not accept tokens.
-
-## Attribution and changes
-
-BERT: Kyoto University NLP group, [original model](https://huggingface.co/ku-nlp/deberta-v2-large-japanese-char-wwm),
-revision `547b0e8b044fba3f9b84d0ab9f990440bd130c8b`. Converted to two FP32 Core ML
-ML Programs with fixed candidate lengths 64/128/256. No retraining or quantization.
-Original and converted BERT: CC BY-SA 4.0, see LICENSE.md.
-Dictionary: Open JTalk / NAIST / UniDic contributors, see dictionary/COPYING.
-These are unofficial conversions, without endorsement by the original authors.
-
-## Usage
-
-Pass `bert/` and `dictionary/` to `ModelPaths`; obtain a voice separately.
-The sample app can import this entire folder as BERT and find the dictionary.
-It can also download from the HTTPS URL of `download.json` at a pinned revision.
-`checksums.json` records every distributed asset. Model compilation happens locally
-on first use; compiled caches are not part of this upload.
-
-Inference is offline. The SBV2CoreML application code has its own AGPL-3.0 license.
-See the accompanying source release for setup and performance measurements.
-
-## SDK, sample apps and converter
-
-[SBV2 Core ML source and documentation](https://github.com/Corvelis/sbv2-coreml/tree/v0.1.0-dev2) includes the Swift SDK,
-iPhone/Mac sample apps and AIVM/Safetensors voice conversion tools.
-The main documentation is Japanese, with an English README as a supplement.
-The code is AGPL-3.0; model and dictionary licenses are listed above.
+# Shared BERT and dictionary for SBV2 Core ML
+
+[日本語](README.md)
+
+For [SBV2 Core ML](https://github.com/Corvelis/sbv2-coreml) on iOS 18+ and macOS 15+ Apple Silicon.
+Download the [companion package](https://huggingface.co/AILogDev/sbv2-coreml-jvnv-f1-jp) as well.
+Package size is approximately 1.52 GB; allow extra space for first-use Core ML compilation.
+
+## Download and use
+
+In the sample's **モデル設定 → URLからモデルを取得**, choose the package type and enter:
+
+```text
+https://huggingface.co/AILogDev/sbv2-coreml-common/resolve/main/download.json
+```
+
+Alternatively use the [Hugging Face CLI](https://huggingface.co/docs/huggingface_hub/guides/cli):
+
+```sh
+hf download AILogDev/sbv2-coreml-common --local-dir models/sbv2-coreml-common
+```
+
+Download the entire folder, including the contents of `.mlpackage` directories.
+Pass `bert/` and `dictionary/` to `ModelPaths`. Select the package root as **共通モデル** in the sample.
+Speech synthesis works offline after downloading both packages.
+
+[Quick Start](https://github.com/Corvelis/sbv2-coreml/blob/main/docs/getting-started.ja.md) ·
+[SDK integration](https://github.com/Corvelis/sbv2-coreml/blob/main/docs/sdk-guide.ja.md)
+
+## Attribution and licenses
+
+BERT by Kyoto University NLP group: [original model](https://huggingface.co/ku-nlp/deberta-v2-large-japanese-char-wwm), revision `547b0e8b044fba3f9b84d0ab9f990440bd130c8b`. Converted to two FP32 Core ML models with input lengths 64/128/256, without retraining or quantization. BERT is CC BY-SA 4.0. The Open JTalk 1.11 UTF-8 dictionary has separate BSD notices in `dictionary/COPYING`.
+
+See [LICENSE.md](LICENSE.md), `provenance.json` and `checksums.json` for licenses,
+conversion details and SHA-256 checksums. This is an unofficial conversion and is not
+endorsed by the original creators. SDK, sample and converter code is **AGPL-3.0**.

README.md

@@ -6,47 +6,43 @@ base_model: ku-nlp/deberta-v2-large-japanese-char-wwm
 ---
 # SBV2 Core ML 共通モデル・辞書
 
-[English（補助）](README.en.md)
+[English](README.en.md)
 
-Style-Bert-VITS2 JP-ExtraをiPhone／Apple Silicon Macで使うための、共通BERTと日本語辞書です。
-iOS 18以上、macOS 15以上のApple Siliconに対応するSwift SDK **SBV2CoreML**から使います。
-一度取得すれば、互換性のある複数の声モデルで使い回せます。声モデルは別途取得してください。
+iPhone／Apple Silicon Macで日本語音声を合成するための、共通BERTとOpen JTalk辞書です。
+[SBV2 Core ML](https://github.com/Corvelis/sbv2-coreml)と、別配布の[声モデル](https://huggingface.co/AILogDev/sbv2-coreml-jvnv-f1-jp)を合わせて使います。
+互換性のある声を追加するとき、この共通モデルを取得し直す必要はありません。
 
-## 配布先
+## 使い方
 
-このパッケージ：[AILogDev/sbv2-coreml-common](https://huggingface.co/AILogDev/sbv2-coreml-common)。
-併せて必要なパッケージ：[AILogDev/sbv2-coreml-jvnv-f1-jp](https://huggingface.co/AILogDev/sbv2-coreml-jvnv-f1-jp)。
-`.mlpackage`を含めた全ファイルを、フォルダ構成のまま取得してください。
-再現可能な取得には固定コミットを指定します。
-Privateの場合は認証付きのHugging Faceクライアントで取得し、サンプルでローカルフォルダを選びます。
-サンプルのHTTPS取得はPublic向けで、アクセストークンの入力機能はありません。
+対応環境はiOS 18以上、macOS 15以上のApple Siliconです。配布ファイルは約1.52 GBです。
+初回のCore MLコンパイル用に、追加の空き容量を用意してください。
 
-## 出典と変換内容
+サンプルアプリの **モデル設定 → URLからモデルを取得** で **共通モデル** を選び、次のURLを入力します。
 
-- **BERT：** 京都大学の自然言語処理研究グループによる[DeBERTa日本語モデル](https://huggingface.co/ku-nlp/deberta-v2-large-japanese-char-wwm)。原本の固定コミットは`547b0e8b044fba3f9b84d0ab9f990440bd130c8b`です。
-- BERTを2つのFP32 Core ML ML Programへ変換しています。入力長の候補は64／128／256です。再学習・量子化は行っていません。
-- 原本と変換済みBERTのライセンスは**CC BY-SA 4.0**です。`LICENSE.md`を参照してください。
-- **辞書：** Open JTalk 1.11 UTF-8辞書です。Open JTalk／NAIST／UniDicの関係者によるBSD系の条件が別途適用されます。`dictionary/COPYING`を参照してください。
+```text
+https://huggingface.co/AILogDev/sbv2-coreml-common/resolve/main/download.json
+```
 
-これは非公式の変換物です。原作者による承認・推奨を示すものではありません。
+Macのターミナルから取得する場合は、[Hugging Face CLI](https://huggingface.co/docs/huggingface_hub/guides/cli)を使います。
 
-## 使い方
+```sh
+hf download AILogDev/sbv2-coreml-common --local-dir models/sbv2-coreml-common
+```
 
-1. `.mlpackage`の中身を含め、このリポジトリのファイルをフォルダ構成のまま取得します。
-2. 別配布の声モデルを用意します。
-3. `ModelPaths`へBERTの`bert/`、辞書の`dictionary/`、声モデルのフォルダを渡します。
+取得したフォルダをサンプルの **共通モデル** として選ぶと、BERTと辞書が自動認識されます。
+SDKへ組み込む場合は、`ModelPaths.bert`へ`bert/`、`ModelPaths.dictionary`へ`dictionary/`を渡します。
+`.mlpackage`の中身を含め、フォルダ全体を取得してください。取得後の音声合成はオフラインで動作します。
 
-付属サンプルでは、この共通フォルダを**共通モデル**として選ぶとBERTと辞書を自動認識します。
-Publicの場合は、固定コミットの`download.json` URLからも取得できます。
-初回使用時には端末上でCore MLをコンパイルします。コンパイル済みキャッシュは配布物に含めていません。
+[サンプルの起動手順](https://github.com/Corvelis/sbv2-coreml/blob/main/docs/getting-started.ja.md) ·
+[SDK導入ガイド](https://github.com/Corvelis/sbv2-coreml/blob/main/docs/sdk-guide.ja.md)
 
-`checksums.json`に配布ファイルのハッシュ、`provenance.json`に原本と変換内容を記録しています。
-推論はモデルの取得後にオフラインで実行できます。
-Swift SDK・サンプル・変換ツールのコードには、モデルとは別にAGPL-3.0が適用されます。
+## 内容とライセンス
 
-## SDK・サンプル・変換ツール
+- **BERT：** 京都大学の自然言語処理研究グループによる[DeBERTa日本語モデル](https://huggingface.co/ku-nlp/deberta-v2-large-japanese-char-wwm)。原本のコミットは`547b0e8b044fba3f9b84d0ab9f990440bd130c8b`です。
+- FP32の2つのCore MLモデ���へ変換しています。入力長は64／128／256。再学習・量子化は行っていません。
+- BERTのライセンスは **CC BY-SA 4.0** です。[LICENSE.md](LICENSE.md)を参照してください。
+- **辞書：** Open JTalk 1.11 UTF-8辞書。BSD系の条件が別途適用されます。[dictionary/COPYING](dictionary/COPYING)を参照してください。
 
-[SBV2 Core MLのソースと日本語ドキュメント](https://github.com/Corvelis/sbv2-coreml/tree/v0.1.0-dev2)に、Swift SDK、
-iPhone／Macサンプル、AIVM／Safetensorsからの声モデル変換ツールを含めています。
-導入方法はリポジトリのクイックスタートとSDKガイドを参照してください。
-コードはAGPL-3.0、モデル・辞書の条件は上記のとおりです。
+原本と変換方法は`provenance.json`、ファイルのSHA-256は`checksums.json`に記載しています。
+非公式の変換物であり、原作者による承認・推奨を示すものではありません。
+SDK・サンプル・変換ツールのコードは **AGPL-3.0** です。

checksums.json

@@ -1,7 +1,7 @@
 {
   "LICENSE.md": "28a9529c7d0bb4dc51f4bf5c116a3d16ef247a052f7591466768ddf563fd1cf5",
-  "README.en.md": "37a00282646a9de0247d76436c6412d0ca5c3e9b48cdb596828f6d30e238632a",
-  "README.md": "8c6fe4e4e159f98ba93484ba787c9fb0222f6356dc2f094fe48f937876a9bd18",
+  "README.en.md": "722dcc26d8241d3b2f0ce6ee7294b8ca287740d8e6ee1959e48b562a7bdb417f",
+  "README.md": "00b8fb77043ac22875eab15a5fc8e059199f93e355ae2bf6dbe19e56543cfbda",
   "bert/coreml_blocks/coreml_bert_blocks_manifest.json": "5fd273dafd28f11c59d8644ddd9f504e45597e6c09027f999dfce07ac0970809",
   "bert/coreml_blocks/group.1-23-conv_enum.mlpackage/Data/com.apple.CoreML/model.mlmodel": "1acdab8e27548295cc1d8afa8c77e4400d81944cc9e0d344c60d06d0bf6dd6bf",
   "bert/coreml_blocks/group.1-23-conv_enum.mlpackage/Data/com.apple.CoreML/weights/weight.bin": "68f09eb086ca37c988610d9ec247fdcf063c47d8c737e891e9c227e24368e51f",

download.json

@@ -9,13 +9,13 @@
     },
     {
       "path": "README.en.md",
-      "sha256": "37a00282646a9de0247d76436c6412d0ca5c3e9b48cdb596828f6d30e238632a",
-      "bytes": 2434
+      "sha256": "722dcc26d8241d3b2f0ce6ee7294b8ca287740d8e6ee1959e48b562a7bdb417f",
+      "bytes": 1876
     },
     {
       "path": "README.md",
-      "sha256": "8c6fe4e4e159f98ba93484ba787c9fb0222f6356dc2f094fe48f937876a9bd18",
-      "bytes": 3533
+      "sha256": "00b8fb77043ac22875eab15a5fc8e059199f93e355ae2bf6dbe19e56543cfbda",
+      "bytes": 2855
     },
     {
       "path": "bert/coreml_blocks/coreml_bert_blocks_manifest.json",
@@ -114,7 +114,7 @@
     },
     {
       "path": "checksums.json",
-      "sha256": "aff8885e9454ad1dd90a2eae447461b44462c1adeed838282124fa69247eeb43",
+      "sha256": "9e36490081d5b2da36730dced786b19ec14e5d9f091f35efffaab65c7ad16a89",
       "bytes": 2389
     }
   ]