[2月末リリース予定!] v0.16 #545

qryxip · 2023-07-22T08:38:05Z

内容

VOICEVOX COREのバージョン0.15をリリースするにあたってのタスクリストをここにまとめます。

Pros 良くなる点

changelogを書くために、一度ここにまとめていこうと思います。

APIが更新されます。
- Python APIでは主要なAPiがasync化します。C APIでも並列実行をサポートする予定です。
- 音声モデルはVVMファイルという形で扱われ、それらを実行時に明示的に読む形式となります。
- その他諸々の改善/変更があります。
ONNX Runtimeのバージョンが上がります。

Cons 悪くなる点

APIに破壊的変更があります。

実現方法

タスクリストは随時更新します。

タスクリスト (オプショナル)

以前のAPIをdeprecatedなものとして残す
- C API
- Python API

VOICEVOXのバージョン

N/A

OSの種類/ディストリ/バージョン

Windows
macOS
Linux

その他

The text was updated successfully, but these errors were encountered:

Hiroshiba · 2023-07-22T12:21:17Z

[議論]となっているいくつかはこちらのコメントで少し議論が進んでいるのでメモ。
#497 (comment)
#497 (comment)

Hiroshiba · 2023-07-22T12:28:20Z

exampleの案内もタスクに含めておくと良いのかなとちょっと思いました！
と思ったけどもうexampleは完成している･･･？

Hiroshiba · 2023-07-22T13:32:17Z

メモです！
inference_coreとstatusはやっているがかなり似ているので、どっちかに統一できると良さそうに感じました。
まあリリースまでにやるべきか微妙ですが、例えばタスクリストに書いておくのはいいかも？

- [ ] \[議論\] `inference_core`と`status`の役割が似ているのでどちらかに統一する？

開発者向けに、VVMのマニフェストの構造に関してのメモがどこかにあると良いなと感じました。

- [ ] VVMのマニフェストのデータ構造に関してメモをどこかに書く

（とりあえずissueの編集がコンフリクトすると良くないのでここにメモって書いています）

Pythonのテストを書くのもここに含めておくと良さそう？

- [ ] Pythonのe2eテストを書く

qryxip · 2023-07-22T20:06:04Z

三つとも追加しました。

Hiroshiba · 2023-07-22T20:16:10Z

追加ありがとうございます！
（editedになってない＆見当たらないので、もしかしたら追加されてないかも･･････？）

qryxip · 2023-07-22T20:34:00Z

あ、確定してませんでした...

Hiroshiba · 2023-07-26T00:11:33Z

実際に製品版のVVMを作ろうとしていたのですが、以前できていたことができなくなっていることに気づきました。
ということでissue立ててみました。時間ある時にやっておこうかなと思います。

[vvm] styleIdとsession.runに渡す数値が異なっているVVMでも音声合成できるようにする #548

マニフェストファイルって本来、対象がどういう情報を持っているかを外向けに公開するものな気がしてきました。バージョンとか名前とか。
だからどちらかというとmetas.jsonの方がマニフェストっぽくて、今manifest.jsonとなっているものはなんか別のものな気がしました。
時間あったらこの辺整理してもいいかもですね。。

Hiroshiba · 2023-08-05T15:46:54Z

製品版のvvmファイルを作成したので共有です！
ここにあるディレクトにあるvvmファイルが読めるはずです。
https://github.com/VOICEVOX/voicevox_fat_resource/tree/main/core/model

このvvmを読めるコアをプレビュービルド中です。
https://github.com/VOICEVOX/voicevox_core/releases/tag/0.15.0-preview.5

Hiroshiba · 2025-01-10T03:59:35Z

downloderがVVMを持ってくるべきか、持ってくるとしてどうするかを議論するためのissueを作ってみました！
（Githubにsub issue機能があったので使ってみようかなと）

0.16用のVVMダウンロードの流れ議論issue #922

（後から探そうとしたとき用の検索用単語：ダウンローダー download ）

#53 の続き。 Refs: VOICEVOX/voicevox_core#545

Hiroshiba · 2025-02-05T17:26:08Z

@qryxip さんと話して、

keep a changelog形式のchangelogを手書きする #704

は対応しないことに決めました！
チェンジログとマイグレーションガイドを書かないということになります。
（マイグレーションガイドはリリース後に書いてもいいかも。要望次第？）

ということで後のタスクはサブタスクにちょくちょくなってる細々としたやつだけかも！！

Hiroshiba · 2025-02-05T18:43:11Z

ダウンローダーがダウンロードするものを現状でレビューしてみました！
課題があったものはsub issue化しました！
課題がないと判断した点をメモコメント残しておきます。

ディレクトリ名がインターフェース名なのかインスタンス名なのか不揃い
- 具体的に言うとonnxruntimeだけ具体的なライブラリ名で、他はc_api/dict/modelsと抽象的な名前になってる
- そもそも抽象的な名前に寄せたい
  - voicevox_coreと書いてその中にMITライセンス文面があると、コア全部がMITだと勘違いされる可能性があるため
- とはいえonnxruntimeディレクトリをどうすればいいのか思いつかない
- なのでonnxruntimeだけ具体的なライブラリ名になってるという例外を設けたということでよさそう
- まあどっちかというとライブラリの中でvoicevox_coreだけ例外という見方の方がいいかも。現状不明。
dictディレクトリだけ略称になってる
- まあ衝突とか特にないし別に良さそう
- どっちかというと「dictionary」の方が良さそうではある
dictディレクトリに、openjtalkの辞書のディレクトリだけが入ってる
- データ構造だけ見ると不要なディレクトリになってはいる
- けどディレクトリ名がないとこれが何なのかわかんないので、ディレクトリをかませても良さそう！
- 可能ならバージョン名などが入らないディレクトリ名にしておくと、バージョンが上がってもexampleなどを変えなくて良いのでメンテナンス性が良い
  - 今はopen_jtalk_dic_utf_8-1.11みたいになってる、たぶん_dic_utf_8-1.11が要らなそう。
    - dicもdictディレクトリからわかるので
onnxruntimeディレクトリはいくつか課題がありそう
- ORTという略称はおそらく避けた方が良さそう
- ORT_LICENSEはvoicevox_onnxruntimeにとってどっちかって言うとサードパーティーなのでそっちに書いた方が良さそう
- ORT_READMEは中で「このプロジェクトは MIT です」と書いているので、voicevox_onnxruntimeの規約と背反しそう
- ただこれらはVOICEOVX COREに関係ないのでissue化は必要なさそう

Hiroshiba · 2025-02-05T20:48:26Z

残ってるタスクについて、0.16時点での変更はマストではないけど、ちょっと考えたのでメモ：

OpenJtalkにすべきかOpenjtalkにすべきかについて、多分将来的に増えていったら「頭だけ大文字」という規則になる気がする。
ChatGPTとかTensorRTとかどうするのか考えるのめんどくさそう。
逆にものすごい長いのが来たら途中で大文字にしたくなるけど、そういうものはないような気もしました。
とはいえ今マストで変えなくても良さそう。将来何か増えた時に破壊的に変更するか考えれば良さそう！

Hiroshiba · 2025-02-05T21:18:32Z

Pythonのドキュメントを眺めてみました！
マストだと感じたタスクはなさそうだったので、issue化してません 🙏
提案が2つと、感想が2つ！

提案
- Synthesizerのcloseの説明があると良いかも
- 非同期APIの説明が「非同期API」だけだけど、音声合成部分が並列に複数実行されないこともあると案内しても良いのかも。
- でも条件がややこしいので一旦何も書かなくてもいいのかも。
ただのコメント
- replace_phoneme_lengthが破壊的置き換えじゃないのはちょっと一般的じゃないかも。
  - でもまあ良い名前思いつかないし、これで良さそう！
  - あとPythonのstr.replaceとかも破壊的な置き換えじゃない。
- ユーザー辞書は保存されているので、過去のバージョンのものが読み込めるように作る必要がありそう。
  - あとちなみにエンジンと互換性はなさそう（エンジンはMecabの型がほぼそのまま）。
  - まあ問題なさそう！

VOICEVOX/voicevox_vvm#5, VOICEVOX/voicevox_vvm#9 を反映する。 BREAKING-CHANGE: VOICEVOX/voicevox_vvm#5 の反映。 Refs: #545

qryxip · 2025-02-09T09:15:01Z

Javaについても0.15.0-preview.16時点で既にあったと思うので、これもスキップするのは厳しそうに思えます。

ちょっとこれについて詳しく議論していなかったと思います。ユーザーの皆様方が一年前の時点でVVMという存在を割とご存知であったことを考えると、ちょっとこれを無視するのは厳しいのではないかと思いました。

私からの提案としては、Android用Javaのリリースを一旦停止するというのはどうでしょうか？つまりこうです。
[追記] こっちじゃなくてsoftprops/action-gh-releaseの方だった。

diff --git a/.github/workflows/build_and_deploy.yml b/.github/workflows/build_and_deploy.yml
index c91dd4be..3a2b9f5e 100644
--- a/.github/workflows/build_and_deploy.yml
+++ b/.github/workflows/build_and_deploy.yml
@@ -270,7 +270,7 @@ jobs:
             ${{ steps.build-voicevox-core-python-api.outputs.whl }}
           target_commitish: ${{ github.sha }}
       - name: Upload voicevox_core_java_api artifact
-        if: fromJson(needs.config.outputs.deploy) && contains(matrix.target, 'android')
+        if: fromJson(needs.config.outputs.deploy) && contains(matrix.target, 'android') && false
         uses: actions/upload-artifact@v4
         with:
           name: voicevox_core_java_api-${{ matrix.artifact_name }}

JavaはRustと違ってcargo add --git https://github.com/VOICEVOX/voicevox_core.git --tag 0.16.0みたいなことはできないはずなので、これで「Javaはリリースしていない」ことにできるかと思います。

0.15.0-preview.16のJavaなんか誰も使っていなかったというのであればよし。そうでなければそのときはそのときで、 #764 のあたりで復活させるということで。

Hiroshiba · 2025-02-09T13:57:55Z

まあたしかにリリースしてないものとするのは難しいかもですねぇ…。
かといって隠すのも工数がかかる…。（あとexampleがある？）

このままビルドしたのが表に出ちゃうけどスルーして破壊的変更した0.17をしれっと出すか、
表に出た0.16java版はサポートしてないけど出して0.17アプデのときに破壊的変更点を列挙するか、
提案にある通りアップロードから外してexampleは「準備中です」みたいにするか、
ですかねぇ…。

外すのもありだと思いますが、他の案だと難しそうでしょうか？
難しそうであれば外しちゃいましょう…！！

qryxip · 2025-02-09T18:37:39Z

リリースするんだったら #991 と #994 みたいなやつは織り込んでおきたいです。織り込むリソースがもう無いのであれば、 #994 の有様を見ても他に色々ありそうなので、バッサリ外してしまうのがいいのではないかと思ってます。

「Java APIをリリースする」みたいなissue立てて #764 のリンクを載せ、 #984 みたいなやつをsub issueにし、そのissue URLを各所に貼るのがよいかなと。

Hiroshiba · 2025-02-09T22:52:28Z

~~他に何も追加するものがなくなった（＝0.16がリリース可能になった）ときにできる限りのことはできればと思います！~~

すみません勘違いしました！
javaを織り込むリソースは0.16にない、と考えて良いと思います！

#872 をやった理由は互換性の確保であるが、よく考えたらそれは #941 で達成できており、むしろ`pause_length: ()`みたいなことをしてしまったために互換性の邪魔になっている。さらに#872でやっている百数行のコードは、実際に VOICEVOX/voicevox_engine#1308 をやるときには用済みとなるようなものであるため、丸ごとリバートしてしまうことにした。 Refs: #545

qryxip added the 機能向上 label Jul 22, 2023

github-actions bot added OS：linux OS：mac OS：win labels Jul 22, 2023

qryxip mentioned this issue Jul 22, 2023

project-vvm-async-api #497

Merged

67 tasks

Hiroshiba mentioned this issue Jul 26, 2023

[vvm] styleIdとsession.runに渡す数値が異なっているVVMでも音声合成できるようにする #548

Closed

This was referenced Jul 28, 2023

mutabilityとasyncnessを仕上げる #553

Merged

Python APIのSynthesizerをclose()可能にする #555

Merged

ドキュメントを刷新する #532

Merged

This was referenced Aug 5, 2023

VVMファイル作成 VOICEVOX/voicevox_fat_resource#4

Merged

製品版VVMを使うようにする #569

Merged

qryxip mentioned this issue Aug 15, 2023

kana: boolをやめ、"_from_kana"を復活させる #577

Merged

This was referenced Aug 23, 2023

VVMのマニフェストの形式の再考 #581

Closed

Rust APIが公開するエラーの種類をErrorKindとして表現する #589

Merged

Hiroshiba mentioned this issue Sep 1, 2023

C API用のzipファイルからmodelディレクトリをなくし、別でmodelダウンロード可能にする #596

Closed

qryxip mentioned this issue Sep 5, 2023

C APIのエラー表示をtracing::error!にする #600

Merged

sevenc-nanashi mentioned this issue Sep 16, 2023

Migrate: 0.15に対応 sevenc-nanashi/voicevox.rb#2

Open

Hiroshiba mentioned this issue Sep 23, 2023

言語ごとのリリースについて #593

Open

3 tasks

This was referenced Jan 15, 2025

feat!: liberate VOICEVOX CORE #825

Merged

ONNX Runtime v1.18をビルドする VOICEVOX/onnxruntime-builder#46

Open

Hiroshiba mentioned this issue Jan 31, 2025

Pythonライブラリはpydanticの依存を外すか、超広範囲なバージョンを受け入れられるように変更したほうが良いかも #960

Open

3 tasks

This was referenced Feb 2, 2025

VOICEVOX_ORT_TERMS.mdを分離して置く VOICEVOX/onnxruntime-builder#72

Closed

feat!: [downloader] voicevox_vvmを0.0.1-preview.4に #964

Merged

feat!: strip -sし、macOSではdSYMも作らない VOICEVOX/onnxruntime-builder#73

Merged

qryxip added a commit to VOICEVOX/onnxruntime-builder that referenced this issue Feb 4, 2025

feat!: strip -sし、macOSではdSYMも作らない (#73)

68c5829

#53 の続き。 Refs: VOICEVOX/voicevox_core#545

qryxip mentioned this issue Feb 5, 2025

keep a changelog形式のchangelogを手書きする #704

Open

3 tasks

qryxip added a commit that referenced this issue Feb 6, 2025

feat!: [downloader] voicevox_vvmを0.0.1-preview.4に (#964)

2fdae0f

VOICEVOX/voicevox_vvm#5, VOICEVOX/voicevox_vvm#9 を反映する。 BREAKING-CHANGE: VOICEVOX/voicevox_vvm#5 の反映。 Refs: #545

Hiroshiba mentioned this issue Feb 7, 2025

feat: [Rust] UserDictからIndexMapへinto可能にする #978

Open

qryxip mentioned this issue Feb 12, 2025

feat!: revert #872 #1004

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[2月末リリース予定!] v0.16 #545

[2月末リリース予定!] v0.16 #545

qryxip commented Jul 22, 2023 •

edited by sevenc-nanashi

Loading

Hiroshiba commented Jul 22, 2023 •

edited

Loading

Hiroshiba commented Jul 22, 2023 •

edited

Loading

Hiroshiba commented Jul 22, 2023 •

edited

Loading

qryxip commented Jul 22, 2023 •

edited

Loading

Hiroshiba commented Jul 22, 2023

qryxip commented Jul 22, 2023

Hiroshiba commented Jul 26, 2023

Hiroshiba commented Aug 5, 2023

Hiroshiba commented Jan 10, 2025 •

edited

Loading

Hiroshiba commented Feb 5, 2025

Hiroshiba commented Feb 5, 2025

Hiroshiba commented Feb 5, 2025

Hiroshiba commented Feb 5, 2025 •

edited

Loading

qryxip commented Feb 9, 2025 •

edited

Loading

Hiroshiba commented Feb 9, 2025

qryxip commented Feb 9, 2025 •

edited

Loading

Hiroshiba commented Feb 9, 2025 •

edited

Loading

[2月末リリース予定!] v0.16 #545

[2月末リリース予定!] v0.16 #545

Comments

qryxip commented Jul 22, 2023 • edited by sevenc-nanashi Loading

内容

Pros 良くなる点

Cons 悪くなる点

実現方法

タスクリスト (オプショナル)

VOICEVOXのバージョン

OSの種類/ディストリ/バージョン

その他

Hiroshiba commented Jul 22, 2023 • edited Loading

Hiroshiba commented Jul 22, 2023 • edited Loading

Hiroshiba commented Jul 22, 2023 • edited Loading

qryxip commented Jul 22, 2023 • edited Loading

Hiroshiba commented Jul 22, 2023

qryxip commented Jul 22, 2023

Hiroshiba commented Jul 26, 2023

Hiroshiba commented Aug 5, 2023

Hiroshiba commented Jan 10, 2025 • edited Loading

Hiroshiba commented Feb 5, 2025

Hiroshiba commented Feb 5, 2025

Hiroshiba commented Feb 5, 2025

Hiroshiba commented Feb 5, 2025 • edited Loading

qryxip commented Feb 9, 2025 • edited Loading

Hiroshiba commented Feb 9, 2025

qryxip commented Feb 9, 2025 • edited Loading

Hiroshiba commented Feb 9, 2025 • edited Loading

qryxip commented Jul 22, 2023 •

edited by sevenc-nanashi

Loading

Hiroshiba commented Jul 22, 2023 •

edited

Loading

Hiroshiba commented Jul 22, 2023 •

edited

Loading

Hiroshiba commented Jul 22, 2023 •

edited

Loading

qryxip commented Jul 22, 2023 •

edited

Loading

Hiroshiba commented Jan 10, 2025 •

edited

Loading

Hiroshiba commented Feb 5, 2025 •

edited

Loading

qryxip commented Feb 9, 2025 •

edited

Loading

qryxip commented Feb 9, 2025 •

edited

Loading

Hiroshiba commented Feb 9, 2025 •

edited

Loading