docs: 監査結果に基づくドキュメント全面同期 (v1.11.0 以降の差分を一括反映) - #368
Merged
Conversation
v1.11.0 以降の実装変更 (#321 OpenAI互換API, #331 Voice Cloning/SSML, #337 短文品質, #342 HTS voice除去, #349/#367 phoneme timing/streaming, #361 FastAPI移行, #366 arm64 Docker) が CHANGELOG・多言語 README・docstring に未反映だった部分を一括同期。新規に C# CLI/Core README を追加。 - ルート CHANGELOG: Unreleased に #360-#366 (FastAPI移行/arm64 Docker/短文崩壊修正/Wyoming HA等) を追記 - 多言語 README 9 ファイル (DE/ES/FR/HI/KO/PT/RU/SV/ZH): Voice Cloning/SSML/Phoneme Timing/Strategy A/B/C/FastAPI を反映 - C# CLI/Core README 新規作成 (src/csharp/PiperPlus.Cli/, PiperPlus.Core/) - WASM CHANGELOG: [0.3.1] セクション追加 + [0.4.0] 日付修正 (0.3.0 と同日問題解消) - docstring 補強: http_server.py FastAPI エンドポイント / inference.py OpenAI 互換 API - HTS voice 残存言及を削除 (windows-setup.md) - --language-balanced-sampling help を 6 言語対応に更新 (バイリンガル時代の遺物修正) - Go README: Docker multi-arch (amd64/arm64) + serve サブコマンドのセクション追加 - pretrained-models.md: つくよみちゃん 6lang-v2 / 6lang ベースモデルの詳細追記 - huggingface-space/docker/README: 言語表記/Go arm64 表記の整合修正
前回コミット (f212aba) では多言語 README 9 ファイルを更新したが、 ベースとなる README.md (日本語) と README_EN.md には Voice Cloning / SSML / 短文品質改善の bullets を入れ忘れていた。 また Rust piper-core/src/lib.rs のクレートドキュメントが「7 言語 (KO 含むが SV を欠く)」のまま、 8 言語 G2P + 6 言語学習済みモデルという最新の状態を反映していなかった。 - README.md / README_EN.md のインターフェースセクション末尾に Voice Cloning / SSML / 短文品質改善 (Strategy A/B/C) の 3 bullets を追加 (多言語版と同等内容) - src/rust/piper-core/src/lib.rs:4 のクレートドキュメントを「8 言語 G2P (JA/EN/ZH/KO/ES/FR/PT/SV)、学習済みモデルは 6 言語」に修正 二次監査で誤指摘と判明した項目はスキップ: - WASM g2p test の "all 7 non-JA languages" は JA を除いた 7 言語の意味で正しい (ALL_NON_JA = en/zh/ko/es/fr/pt/sv) - C# CLI README の --debug/--quiet/--version はすでに L66 に記載済み
二次監査で「低優先度・別 PR 推奨」と棚上げした 5 項目に対応。レガシー API (BILINGUAL/espeak) の意図と廃止予定を明示し、サンプル/パッケージのバージョン 管理状況をユーザーが誤解しないようドキュメント化する目的。 - Go (src/go/piperplus/config.go): PhonemeTypeEspeak / PhonemeTypeBilingual に Deprecated コメント追加 (CONTRIBUTING.md "espeak-ng Policy" / PR #218 への参照付き) - Python (src/python_run/piper/voice.py): PhonemeType.BILINGUAL 分岐に Deprecation 注記 + SV/KO が学習済みモデル未対応の理由をコメント化 - C# (src/csharp/PiperPlus.Core/Config/PiperConfig.cs): Espeak フィールドに XML doc 追加 (legacy config.json 互換のみ、新規モデルは null とする旨) - examples/{c-api,dart,godot}/README.md: CI で実行検証されているか否かを 各 README 冒頭に明示 (c-api はビルドのみ検証、dart/godot は未検証) - CONTRIBUTING.md: "Package Versioning Policy" セクション新規追加 (8 パッケージそれぞれの独立バージョン管理ポリシーとタグ命名規則を表形式で明文化) 実装ロジックには変更なし (コメント・docstring・README のみ)。
There was a problem hiding this comment.
Pull request overview
監査結果に基づき、v1.11.0 以降の実装差分が未反映だったドキュメント群（CHANGELOG、多言語 README、各ランタイム README、主要 docstring）をまとめて同期し、C# CLI/Core の README を新規追加するPRです。
Changes:
- Unreleased CHANGELOG の追記と、各種 README/ガイドの実装追従（FastAPI、Phoneme Timing、短文対策、Voice Cloning、SSML、Docker multi-arch 等）
- C# の
PiperPlus.Core/PiperPlus.CliREADME を新規追加 - WASM npm パッケージ側 CHANGELOG のバージョン・日付・リンク整備
Reviewed changes
Copilot reviewed 31 out of 31 changed files in this pull request and generated 16 comments.
Show a summary per file
| File | Description |
|---|---|
| CHANGELOG.md | Unreleased に #360-#366 を反映（Changed/Fixed/Doc/Chore セクション追加） |
| src/wasm/openjtalk-web/CHANGELOG.md | npm パッケージの 0.3.1 追記、日付修正、タグリンク追加 |
| src/python_run/piper/http_server.py | FastAPI エンドポイント関数に docstring 追加 |
| src/python/piper_train/main.py | --language-balanced-sampling の help を更新 |
| src/go/README.md | Go Docker multi-arch と serve サブコマンド説明を拡充 |
| src/csharp/PiperPlus.Core/README.md | Core ライブラリ README 新規追加（利用方法・型一覧など） |
| src/csharp/PiperPlus.Cli/README.md | CLI README 新規追加（インストール・主要オプションなど） |
| docker/python-inference/inference.py | 推論用 FastAPI サーバのモジュール docstring 更新 |
| docs/getting-started/windows-setup.md | Windows セットアップ手順から HTS voice 言及を整理 |
| docs/guides/pretrained-models.md | 6lang-v2 / base モデルの学習詳細を追記 |
| docker/README.md | Go イメージの説明（multi-arch 等）を更新 |
| huggingface-space/README.md | デモモデルの対応言語状況を明確化（表の拡張） |
| README_DE.md | 多言語 README へ機能差分（Phoneme Timing/SSML 等）を反映 |
| README_ES.md | 多言語 README へ機能差分（Phoneme Timing/SSML 等）を反映 |
| README_FR.md | 多言語 README へ機能差分（Phoneme Timing/SSML 等）を反映 |
| README_HI.md | 多言語 README へ機能差分（Phoneme Timing/SSML 等）を反映 |
| README_KO.md | 多言語 README へ機能差分（Phoneme Timing/SSML 等）を反映 |
| README_PT.md | 多言語 README へ機能差分（Phoneme Timing/SSML 等）を反映 |
| README_RU.md | 多言語 README へ機能差分（Phoneme Timing/SSML 等）を反映 |
| README_SV.md | 多言語 README へ機能差分（Phoneme Timing/SSML 等）を反映 |
| README_ZH.md | 多言語 README へ機能差分（Phoneme Timing/SSML 等）を反映 |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Copilot pull-request reviewer が PR #368 に付けた 16 件のレビューコメントと、 それを契機にした再監査で見つかった整合性問題を一括解消。リリース直前の 一貫性確認に過ぎないので、いずれもドキュメント・コメントレベルの調整のみ。 Copilot 指摘 (16件): - 多言語 README 11 ファイル (README.md/EN/DE/ES/FR/HI/KO/PT/RU/SV/ZH): bullets が 「7 ランタイム」と書きながら列挙は 6 つだったのを「6 ランタイム」に統一。 日本語版/英語版は libpiper_plus を C++ にまとめる旨を補足 - docker/python-inference/inference.py: モジュール docstring が定義されていない `POST /api/phoneme-timing` を載せ、`/synthesize` を POST と書いていたのを修正 (該当エンドポイントは src/python_run/piper/http_server.py 側であることも明記) - src/python/piper_train/__main__.py:255-260: `--language-balanced-sampling` が `num_speakers > 1` も必要 (single-speaker は SpeakerBalancedBatchSampler を バイパス) という条件を help に追記 - docker/README.md:19: Go Dockerfile 行の base image を `golang:1.22` から 実際の `golang:1.26` に修正 - src/go/README.md:380-: `docker buildx build` の例に `--load` (single-arch) と `--push` (multi-arch) の両パターンを示し、ローカル実行不可だった例を解消 - src/go/README.md:298 / 406: 見出し「## HTTP API / HTTPエンドポイント」を 「## HTTP API」に変更してアンカーを `#http-api` に統一、リンク `[HTTP API](#http-api--http-api)` の broken anchor を修正 - src/csharp/PiperPlus.Core/README.md:34: `new DotNetG2PEngine()` は PiperPlus.Cli の `internal sealed class` で外部から呼べないため、 IJapaneseG2PEngine を持ち込む必要がある旨を明記したサンプルに置換
5 tasks
ayutaz
added a commit
that referenced
this pull request
May 14, 2026
- src/rust/piper-cli/src/main.rs: phoneme_silence_map がパースのみで未適用な状態を、より具体的な TODO コメントに書き換え。他ランタイム (Python/C#/Go) は既に boundary 挿入を 実装済みのため、参照先 (C# Program.cs:1051, Go main.go:197) を明示。 - src/cpp/tests/test_dictionary_manager.cpp: コメントアウトされていた 2 つの test ブロック (GetDefaultDictPath / CheckDictionary) を GoogleTest の DISABLED_ プレフィックス + GTEST_SKIP() 形式に置換。未実装 C API (openjtalk_get_default_dict_path / openjtalk_check_dictionary) を 明示し、関数追加時に自動で pick-up されるよう構造化。CustomDictPath test 内の中間 TODO コメントも文脈を補強。 - Go deprecated 警告 (PhonemeTypeEspeak / PhonemeTypeBilingual) は PR #368 で既に追加済みのため本 PR では変更なし。 ロジック変更ゼロ (警告/TODO 整理のみ)。
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
エージェントチームでドキュメント全体を監査した結果、v1.11.0 (2026-04-06) 以降の主要な実装変更がドキュメントに未反映だったため、CHANGELOG・多言語 README・docstring・各ランタイム README に一括反映しました。新規に C# CLI/Core README を作成しています。
監査で発見した不整合 (主要なもの)
高優先度
30 秒で試す(docs(readme): 「30秒で試す」を OS 別ワンライナー化 + CLI バイナリ選択ガイド追加 (#359) #360)、Voice Cloning (Voice Cloning, SSML, Unity UPM, Wyoming Docker 他全実装 #331)、SSML (Voice Cloning, SSML, Unity UPM, Wyoming Docker 他全実装 #331)、Phoneme Timing (feat: Python と JS/WASM ランタイムに phoneme timing 機能を追加 #349)、FastAPI ストリーミング (feat(http-server): Flask → FastAPI 移行 + ストリーミング対応 (#358) #361)、短文品質改善 (feat: 短テキスト合成品質改善 (Strategy A/B/C) を全7ランタイムに実装 #337) を未反映--language-balanced-samplinghelp がJA 50%% / EN 50%%のままバイリンガル時代の遺物docs/getting-started/windows-setup.md:129に HTS voice 残存言及 (PR refactor: HTS voice 依存を完全除去 #342 で除去済み)中優先度
openjtalk-web/CHANGELOG.mdに[0.3.1]記載なし (npm-v0.3.1 タグは存在)、[0.3.0]と[0.4.0]が同日付serveサブコマンドの記載が薄いpretrained-models.mdに不足http_server.py(FastAPI) /inference.py(OpenAI 互換 API) のモジュール docstring が旧仕様のまま主な変更内容
CHANGELOG.mdREADME_*.md(9 ファイル)src/csharp/PiperPlus.{Cli,Core}/README.mdsrc/wasm/openjtalk-web/CHANGELOG.md[0.3.1]セクション追加 +[0.4.0]日付修正 + リンク補完src/python/piper_train/__main__.py--language-balanced-samplinghelp を 6 言語対応に更新src/python_run/piper/http_server.pyapp_synthesize,app_phoneme_timing) に docstring 追加docker/python-inference/inference.pydocs/getting-started/windows-setup.mddocs/guides/pretrained-models.mdsrc/go/README.mdserveサブコマンドのセクション新設huggingface-space/README.md/docker/README.md合計 21 ファイル / +482 -86 行
監査基準
CLAUDE.md (実装の真実) ↔ git log (#299-#367) ↔ ドキュメント の三方向で不整合を検出。エージェント 5 件並列で実施 (Explore で読み取り、編集はメインスレッドと general-purpose エージェント)。
Test plan
CHANGELOG.mdの Unreleased が Keep a Changelog 規約に準拠しているか確認python -m piper_train --helpで--language-balanced-samplingの説明が更新されているか確認docs/guides/pretrained-models.mdのリンクが有効か確認補足: HuggingFace 用 README は対象外
test/models/tsukuyomi-chan/README.mdも「(WavLM + Prosody)→(6lang-v2)」へ更新したが、.gitignore(models/) で git 管理外のため本 PR には含めない。HuggingFace モデルカードへのアップロードは別途実施が必要。