ONNX版の自動ビルドを追加

[aoirint]

内容

ONNX COREのGitHub Actionsによる自動ビルドを追加します。

実行は3分くらいで終わります。

• ビルド: https://github.com/aoirint/voicevox_core/actions/runs/1395462360
• Artifactへのアップロード
  • OS・アーキテクチャ・CPU/GPU別にアップロード
  • ファイル名はcore.dll、libcore.dylib、libcore.so
• Releaseへのアップロード: https://github.com/aoirint/voicevox_core/releases/tag/0.7.4-aoirint-9
  • 0.7.4のcore.zipと同じ階層構造のcore.zipをアップロード
  • ファイル名はcore_cpu.dll、libcore_cpu.dylib、libcore_cpu.soのようにリネーム
• macOS 自動ビルド実行時に出る警告 Found 2 matching packages.
  • ビルドにはmacOS 10.15を使っています
  • cmakeのReleaseで、macOS10.13+、10.10+向けの2つのRelease Assetがあるために起きています
  • 動作に問題はないので無視しています
  • Warning: two versions found on macOS jwlawson/actions-setup-cmake#26

議論

• 共有ライブラリのファイル名フォーマット
  • もともとあったファイルは、そのままの名前
  • 新しく増えたx86、Arm向けビルドはcore_cpu_x86.dll、core_cpu_arm64.dll、core_cpu_arm.dll
  • ONNX Runtimeの配布物はwin-x86、win-arm、win-x64-gpuのようなフォーマット
    • GitHub Actions内ではONNX Runtimeのフォーマットをベースにした名付けにしている
• 暗号化された *.bin の読み込みに対応

https://github.com/Hiroshiba/voicevox_core/blob/f59c6fbe20f248a094afbe717a4c1127ed5ceb96/onnx/core.cpp#L29-L36

• *.bin、metas.json、README.txtの追加
• 依存関係のライセンス情報の追加 依存ライブラリのライセンスを管理できるようにする #29

対応環境

• https://github.com/microsoft/onnxruntime/releases/tag/v1.9.0

ONNX RuntimeのReleaseに含まれていた以下の環境でビルドするようにしています。

• Windows x64 GPU
• Windows x64 CPU
• Windows x86 CPU
• Windows arm64 CPU
• Windows arm32 CPU
• macOS x64 CPU
• Linux x64 GPU
• Linux x64 CPU

関連 Issue

close #28
ref #21

[Hiroshiba]

良いですね・・・！

win-x64-gpu

AMDのgpuでは動かないということを説明無しでわかるように、-nvidiaにしておいても良いのかなと思いました。
（もしかしてnvidia以外のgpuでも動いたりするんでしょうか・・・？）

暗号化された *.bin の読み込みに対応

一旦暗号化はOSSでメンテしない方針が良いのかなと思っています。
復号化キーと暗号化アルゴリズムが両方ほぼオープンな状態になるので、かなり弱くなりそうなためです。
OSSでもそこそこ強く暗号化できる方法があれば適用してみたいです。

[aoirint]

AMDのgpuでは動かない

動かないみたいです。
ONNX RuntimeのGPU版はCUDAとTensorRT（どちらもNVIDIA）で動くようです。
（PyTorchの場合はTorchScriptがTensorRTでも動いた気がするので、ONNX化でNVIDIA Jetsonを使った組み込みでGPU動作するのかな、と思いましたが、Linux arm版が必要ですね...）

• https://github.com/microsoft/onnxruntime/releases/tag/v1.9.0#~:~:text=Packages
• https://proc-cpuinfo.fixstars.com/2018/03/tensorrt-00/

win-x64-gpu

win-x64-gpu はONNX Runtime側で付けられている名前（zipのファイル名）なので、
そのままActionsの内部名として使っている形になります。
ユーザから見える共有ライブラリの名前は一応変えていません。

-nvidia/-x64-nvidiaでいい気もします。
まあ、ここ（内部名）を変えると、共有ライブラリのCPU x64とarm64を区別するのに、_cpu、_cpu_arm64のような名前になっているところを、 _x64/_cpu_x64とか_arm64/_cpu_arm64にしたくなる気もします...（アーキテクチャを後ろに付け足す命名規則はこのPRからですが）。

暗号化はOSSでメンテしない方針

👍 いったんその方針でいいと思います。

開発的には、いい方法を見つけたい...。

[Hiroshiba]

命名、微妙に悩みますね･･･

ユーザー的にわかりやすい形にするために、冗長ですがcpuやgpuのprefixも付けるのが良さそうに思いました。

cpuのみ対応版の場合は_cpu_x64や_cpu_arm64に、
gpuも対応版は_gpu_x64_nvidiaや_gpu_arm64_nvidiaでいきましょう！

[aoirint]

cpuのみ対応版の場合は_cpu_x64や_cpu_arm64に、
gpuも対応版は_gpu_x64_nvidiaや_gpu_arm64_nvidiaでいきましょう！

ENGINE側でも対応が必要と思いますが、ONNX対応と合わせて変えやすいので、いいと思います。
Artifactにアップロードするcore.zip内でのファイル名をそのルールに変えました。

ONNX化をリリースするときに、ドキュメントの変更も必要そうです。

https://github.com/Hiroshiba/voicevox_core/blob/42acc417bc3efb08009c669a7752c378698e5fb2/README.md?plain=1#L38

[Hiroshiba]

LGTM！！

ONNXリリースの際は必ずREADMEの書き換えや稼働チェックが入るので、ドキュメントはちゃんと修正されると思います！

お試しでreleases作ってみますね。