Skip to content

Commit 711d8b4

Browse files
authored
docs: CHANGELOG.mdを手直しする (VOICEVOX#1144)
1 parent 9e6b96a commit 711d8b4

File tree

1 file changed

+65
-31
lines changed

1 file changed

+65
-31
lines changed

CHANGELOG.md

Lines changed: 65 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -118,9 +118,11 @@
118118
- `Mora`
119119
</details>
120120

121-
- `VoiceModelId`が指すIDの意味がドキュメンテーションコメントに書かれます ([#1143])。
121+
- `VoiceModelId`が指すIDが何に対して固有なのかが暫定的に定められ、ドキュメンテーションコメントに書かれます ([#1143])。
122122

123-
- バージョン0.14.0からの歴史をまとめた[Keep a Changelog](https://keepachangelog.com)形式のCHANGELOG.mdが追加されます。またこのバージョンから、GitHub Releasesの本文にも同じ内容が載るようになります ([#1109], [#1116], [#1117], [#1124], [#1125], [#1126], [#1128], [#1131], [#1132], [#1123], [#1133], [#1134], [#1137], [#1136], [#1138], [#1139], [#1140], [#1118], [#1143])。
123+
後述する[VOICEVOX/voicevox\_vvmのバージョン0.16.0](https://github.com/VOICEVOX/voicevox_vvm/releases/tag/0.16.0)で、IDを変えないまま`Character::version`のみ変えた([VOICEVOX/voicevox\_vvm#34])際に定めたものです。詳細はドキュメンテーションコメントをご覧ください。
124+
125+
- バージョン0.14.0からの歴史をまとめた[Keep a Changelog](https://keepachangelog.com)形式のCHANGELOG.mdが追加されます。またこのバージョンから、GitHub Releasesの本文にも同じ内容が載るようになります ([#1109], [#1116], [#1117], [#1124], [#1125], [#1126], [#1128], [#1131], [#1132], [#1123], [#1133], [#1134], [#1137], [#1136], [#1138], [#1139], [#1140], [#1118], [#1143], [#1144])。
124126

125127
- \[Rust\] Rust Analyzerが、C APIから参照する目的で[0.16.0-preview.0](#0160-preview0---2025-03-01-0900)[#976]にて導入した`doc(alias)`に反応しないようになります ([#1099])。
126128

@@ -161,11 +163,11 @@
161163

162164
これらの挙動は将来的に変更される予定であり、議論は[#1127]で行われています。
163165

164-
- \[ダウンローダー\] `--models-version <SEMVER>`オプションが追加されます ([#1134], [#1137], [#1138])。
166+
- \[ダウンローダー\] `--models-version <SEMVER>`オプションが追加されます ([#1134], [#1137], [#1138], [#1136], [#1118])。
165167

166168
```console
167169
--models-version <SEMVER>
168-
VOICEVOX音声モデル (`models`)のバージョン。省略時は`>=0.1, <0.2`のうち最新
170+
VOICEVOX音声モデル (`models`)のバージョン。省略時は`>=0.16, <0.17`のうちpre-releaseではない最新
169171
```
170172

171173
ダウンローダーから見て未来のバージョンを使うことも可能になります。ただしその場合警告は出ます。
@@ -203,7 +205,7 @@
203205

204206
- \[ダウンローダー\] 環境変数`GITHUB_TOKEN`でGitHubの認証トークンをセットする機能がドキュメント化されます ([#1128])。
205207

206-
Rust版ダウンローダー実装当初 (#350)から存在した機能ですが、このたび正式に使い方が説明されます。
208+
Rust版ダウンローダー実装当初 ([#375])から存在した機能ですが、このたび正式に使い方が説明されます。
207209

208210
- \[ダウンローダー\] 環境変数`GITHUB_TOKEN`に加え、`GH_TOKEN`でもGitHubの認証トークンをセットすることができるようになります ([#1131])。
209211

@@ -230,15 +232,19 @@
230232

231233
ただし、`windows-2022`でビルドしたバイナリであっても`windows-2019`相当の環境で動作すると考えられています。またVOICEVOX ONNX Runtimeが既に元々`windows-2022`でビルドされているため、通常の用途においては特に変わらないはずです。
232234

235+
- \[Rust\] 依存ライブラリのバージョン要求が変わります ([#1070], [#1078])。
236+
237+
- `proc-macro2@1`: `^1.0.86` → `^1.0.95`
238+
- `syn@2`: `^2.0.79` → `^1.0.86`
239+
233240
### Fixed
234241

235-
- \[Rust\] Nightly Rustでビルドできない問題([dtolnay/proc-macro2#497])が発生したため、`proc-macro2`の依存がv1.0.95に上がります ([#1078])。
236242
- \[Python\] リポジトリにあるMarkdownドキュメントの誤記が修正されます ([#1063])。
237243
- \[Java\] \[Android\] GHAのUbuntuイメージ備え付けの`$ANDROID_NDK` (現時点ではバージョン27)を使ったリリースがされるようになります。これにより、[#1103]で報告されたAndroidビルドにおけるC++シンボルの問題が解決されます ([#1108])。
238244
- \[Java\] Javaのファイナライザから中身のRustオブジェクトのデストラクトがされない問題が解決されます ([#1085])。
239245
- \[ダウンローダー\] 将来的に[VOICEVOX/voicevox\_vvm]のタグの数が30を超えたときに、もしかしたら起きうるかもしれない問題の対処がされます ([#1123])。
240246
- \[ダウンローダー\] いくつかのエラーの出かたが改善されます ([#1132], [#1133], [#1136])。
241-
- \[ダウンローダー\] `--devices <DEVICES>...`のhelpにはダウンローダーの誕生 ([#249])からずっと「(cudaはlinuxのみ)」と書かれていましたが、この記述は当時から正しくなかったので消されます ([#1124])。
247+
- \[ダウンローダー\] `--devices <DEVICES>...`のhelpには「(cudaはlinuxのみ)」と書かれていましたが、この記述は[0.16.0-preview.0](#0160-preview0---2025-03-01-0900)の時点で正しくなくなっていたため消されます ([#1124])。
242248
- \[ダウンローダー\] \[Windows\] GitHub Releasesにおいて、再び署名がされるようになります ([#1060])。
243249

244250
## [0.16.0] - 2025-03-29 (+09:00)
@@ -283,7 +289,7 @@
283289

284290
### Added
285291

286-
- 書きかけの状態だった[docs/guide/user/usage.md](https://github.com/VOICEVOX/voicevox_core/blob/0.16.0-preview.1/docs/guide/user/usage.md)が書き上がります ([#1032])。
292+
- [0.16.0-preview.0](#0160-preview0---2025-03-01-0900)にて追加された時点では書きかけの状態だった、[docs/guide/user/usage.md](https://github.com/VOICEVOX/voicevox_core/blob/0.16.0-preview.1/docs/guide/user/usage.md)が書き上がります ([#1032])。
287293
- readmeから「バージョン 0.15.4をご利用ください」の注意書きが削除されます ([#1035])。
288294

289295
### Changed
@@ -293,8 +299,8 @@
293299

294300
### Removed
295301

296-
- sample.vvmはGitHub Releasesに含まれなくなります ([#1033])。
297-
- \[Linux\] \[BREAKING\] Ubuntu 20.04がサポート対象から外れ、バイナリのリリースはUbuntu 22.04で行われるようになります ([#1028])。
302+
- [0.16.0-preview.0](#0160-preview0---2025-03-01-0900)では製品版VVMがこのリポジトリのGitHub Releasesに置かれなくなり、代わりにsample.vvmが置かれていましたが、今回からそれも無くなります ([#1033])。
303+
- \[Linux\] \[BREAKING\] Ubuntu 20.04がサポート対象から外れ、バイナリのリリースはUbuntu 22.04で行われるようになります。それに伴い、glibcの最小バージョンが2.31から2.34に上がります ([#1028])。
298304

299305
### Fixed
300306

@@ -453,23 +459,48 @@
453459

454460
これにより、VOICEVOX ENGINEとVOICEVOX COREとで同じ`AudioQuery`と`UserDictWord`が使い回せるようになります。Python APIおよびJava APIにおける、クラスの形には影響しません。
455461

456-
```json
457-
{
458-
"accent_phrases": […],
459-
"speedScale": 1.0,
460-
"pitchScale": 0.0,
461-
"intonationScale": 1.0,
462-
"volumeScale": 1.0,
463-
"prePhonemeLength": 0.1,
464-
"postPhonemeLength": 0.1,
465-
"outputSamplingRate": 24000,
466-
"outputStereo": false
467-
}
468-
```
462+
- <details><summary><code>AudioQuery</code>の例</summary>
463+
464+
```json
465+
{
466+
"accent_phrases": […],
467+
"speedScale": 1.0,
468+
"pitchScale": 0.0,
469+
"intonationScale": 1.0,
470+
"volumeScale": 1.0,
471+
"prePhonemeLength": 0.1,
472+
"postPhonemeLength": 0.1,
473+
"outputSamplingRate": 24000,
474+
"outputStereo": false
475+
}
476+
```
477+
</details>
478+
- <details><summary><code>UserDictWord</code>の例</summary>
479+
480+
```json
481+
{
482+
"surface": "手札",
483+
"priority": 6,
484+
"context_id": 1345,
485+
"part_of_speech": "名詞",
486+
"part_of_speech_detail_1": "一般",
487+
"part_of_speech_detail_2": "*",
488+
"part_of_speech_detail_3": "*",
489+
"inflectional_type": "*",
490+
"inflectional_form": "*",
491+
"stem": "*",
492+
"yomi": "テフダ",
493+
"pronunciation": "テフダ",
494+
"accent_type": 0,
495+
"mora_count": 3,
496+
"accent_associative_rule": "*"
497+
}
498+
```
499+
</details>
469500

470501
- \[BREAKING\] `VoiceModelId`は、VVMに固有のUUIDになります ([#796])。
471502

472-
この「固有」の意味については、[VOICEVOX/voicevox\_vvm#19]にて議論されることになります
503+
補足: この「固有」の意味については[#1143]で補足されます
473504

474505
- \[BREAKING\] 一部のエラーの名前が変わります ([#823], [#919])。
475506

@@ -480,10 +511,6 @@
480511

481512
VOICEVOX ENGINEに合わせる形です。
482513

483-
- \[BREAKING\] `UserDictWord`の`priority`のデフォルトが`0`から`5`に変わります ([#1002])。
484-
485-
Python API、Java API、VOICEVOX ENGINEに合わせる形です。
486-
487514
- \[BREAKING\] `acceleration_mode`を`GPU`または`AUTO`(デフォルト)にしたときの挙動が変わります ([#810])。
488515

489516
`Synthesizer`のコンストラクトの時点でGPUの簡易的なチェックを行うことで、適切なGPUの種類が選択されるようになります。チェックがすべて失敗した場合、`GPU`であればエラー、`AUTO`であればCPUにフォールバックとなります。
@@ -504,6 +531,10 @@
504531

505532
`voicevox_voice_model_file_create_metas_json`になり、`VoicevoxVoiceModelFile`が保有しない形でアロケートされた文字列を作成するように。
506533

534+
- \[C\] \[BREAKING\] `UserDictWord`の`priority`のデフォルトが`0`から`5`に変わります ([#1002])。
535+
536+
Python API、Java API、VOICEVOX ENGINEに合わせる形です。
537+
507538
- \[C\] \[BREAKING\] リリース内容物において、動的ライブラリはlib/に、ヘッダはinclude/に入るようになります ([#954], [#967], [#980])。
508539

509540
```
@@ -594,6 +625,8 @@
594625
- README.mdはREADME.txtとして置かれるようになります。
595626
- [0.15.0-preview.16](#0150-preview16---2023-12-01-0900)まで含まれていたmetas.jsonは無くなります。
596627

628+
- \[ダウンローダー\] \\[BREAKING\] `--device`は`--devices`に改名され、複数の引数を取ることが可能になります ([#810])。
629+
597630
### Deprecated
598631

599632
- \[Python,Java\] PydanticおよびGSONは廃止予定になります ([#985])。
@@ -1043,8 +1076,8 @@ Windows版ダウンローダーのビルドに失敗しています。
10431076
[0.15.0-preview.4]: https://github.com/VOICEVOX/voicevox_core/compare/0.15.0-preview.3...0.15.0-preview.4
10441077
[0.15.0-preview.3]: https://github.com/VOICEVOX/voicevox_core/compare/0.14.0...0.15.0-preview.3
10451078

1046-
[#249]: https://github.com/VOICEVOX/voicevox_core/pull/249
10471079
[#370]: https://github.com/VOICEVOX/voicevox_core/pull/370
1080+
[#375]: https://github.com/VOICEVOX/voicevox_core/pull/375
10481081
[#392]: https://github.com/VOICEVOX/voicevox_core/pull/392
10491082
[#400]: https://github.com/VOICEVOX/voicevox_core/pull/400
10501083
[#404]: https://github.com/VOICEVOX/voicevox_core/pull/404
@@ -1337,6 +1370,7 @@ Windows版ダウンローダーのビルドに失敗しています。
13371370
[#1058]: https://github.com/VOICEVOX/voicevox_core/pull/1058
13381371
[#1060]: https://github.com/VOICEVOX/voicevox_core/pull/1060
13391372
[#1063]: https://github.com/VOICEVOX/voicevox_core/pull/1063
1373+
[#1070]: https://github.com/VOICEVOX/voicevox_core/pull/1070
13401374
[#1073]: https://github.com/VOICEVOX/voicevox_core/pull/1073
13411375
[#1077]: https://github.com/VOICEVOX/voicevox_core/pull/1077
13421376
[#1078]: https://github.com/VOICEVOX/voicevox_core/pull/1078
@@ -1359,6 +1393,7 @@ Windows版ダウンローダーのビルドに失敗しています。
13591393
[#1123]: https://github.com/VOICEVOX/voicevox_core/pull/1123
13601394
[#1124]: https://github.com/VOICEVOX/voicevox_core/pull/1124
13611395
[#1125]: https://github.com/VOICEVOX/voicevox_core/pull/1125
1396+
[#1126]: https://github.com/VOICEVOX/voicevox_core/pull/1126
13621397
[#1127]: https://github.com/VOICEVOX/voicevox_core/issues/1127
13631398
[#1128]: https://github.com/VOICEVOX/voicevox_core/pull/1128
13641399
[#1131]: https://github.com/VOICEVOX/voicevox_core/pull/1131
@@ -1371,6 +1406,7 @@ Windows版ダウンローダーのビルドに失敗しています。
13711406
[#1139]: https://github.com/VOICEVOX/voicevox_core/pull/1139
13721407
[#1140]: https://github.com/VOICEVOX/voicevox_core/pull/1140
13731408
[#1143]: https://github.com/VOICEVOX/voicevox_core/pull/1143
1409+
[#1144]: https://github.com/VOICEVOX/voicevox_core/pull/1144
13741410

13751411
[VOICEVOX/onnxruntime-builder#25]: https://github.com/VOICEVOX/onnxruntime-builder/pull/25
13761412

@@ -1391,8 +1427,6 @@ Windows版ダウンローダーのビルドに失敗しています。
13911427

13921428
[Hiroshiba/vv\_core\_inference#12]: https://github.com/Hiroshiba/vv_core_inference/pull/12
13931429

1394-
[dtolnay/proc-macro2#497]: https://github.com/dtolnay/proc-macro2/pull/497
1395-
13961430
[@char5742]: https://github.com/char5742
13971431
[@cm-ayf]: https://github.com/cm-ayf
13981432
[@eyr1n]: https://github.com/eyr1n

0 commit comments

Comments
 (0)