support iOS #19

HyodaKazuaki · 2023-04-03T14:53:10Z

iOSのアーキテクチャに対応します。

サポートするRustターゲット

aarch64-apple-ios
- iOSの実機
aarch64-apple-ios-sim
- Apple Silicon MacでのiOSシミュレータ
x86_64-apple-ios
- Intel MacでのiOSシミュレータ

関連Issue

VOICEVOX/voicevox_core#459

add aarch64-apple-ios add aarch64-apple-ios-sim

change build directory change default strategy compile to download use compile strategy for iOS build on GitHub actions

use cocoapods prebuild

fix x86_64-apple-ios target build add x86_64-apple-ios target bindings

Hiroshiba

あ！！　ちょっと認識違いが起こっていることに気づきました 🙇‍♂️

onnxruntime.dylibのビルドは、onnxruntime-builder側で行うのを想像していました。。
VOICEVOX/voicevox_core#459 (comment)

↑のコメントの続きで-rsの方を示されてることに気づきませんでした。。申し訳ない。。
VOICEVOX/voicevox_core#459 (comment)

onnxruntime-builderではbuild.yml内にてGithub Actionsでビルドを行っています。
既存コードとしてラズパイなど用のarmhfのビルドコードがあります。
https://github.com/VOICEVOX/onnxruntime-builder/blob/main/.github/workflows/build.yml

とはいえ、まあonnxruntime-rs側でビルドを行うのもありかもです。
将来的にonnxruntime-rsはonnxruntime純正のものを使う計画もあること、たぶんRustでビルドを書くよりshell scriptで書くほうがスリムなこともあり、メンテナ的にはbuilder側でビルドできると嬉しいのが本音です。

Github Actionsの練習がてらまあ良いか〜と思ってくださるのであればbuilderに移行を、あるいはとにかくiOSで動かせるか最速で試したい感じであればこのまま続行が良いのかなと思ったのですが･･･いかがでしょうか 🙇

.github/actions/auto_gen_bind_pr/action.yaml

HyodaKazuaki · 2023-04-06T14:48:52Z

あ！！　ちょっと認識違いが起こっていることに気づきました 🙇‍♂️

onnxruntime.dylibのビルドは、onnxruntime-builder側で行うのを想像していました。。 VOICEVOX/voicevox_core#459 (comment)

↑のコメントの続きで-rsの方を示されてることに気づきませんでした。。申し訳ない。。 VOICEVOX/voicevox_core#459 (comment)

onnxruntime-builderではbuild.yml内にてGithub Actionsでビルドを行っています。既存コードとしてラズパイなど用のarmhfのビルドコードがあります。 https://github.com/VOICEVOX/onnxruntime-builder/blob/main/.github/workflows/build.yml

とはいえ、まあonnxruntime-rs側でビルドを行うのもありかもです。将来的にonnxruntime-rsはonnxruntime純正のものを使う計画もあること、たぶんRustでビルドを書くよりshell scriptで書くほうがスリムなこともあり、メンテナ的にはbuilder側でビルドできると嬉しいのが本音です。

Github Actionsの練習がてらまあ良いか〜と思ってくださるのであればbuilderに移行を、あるいはとにかくiOSで動かせるか最速で試したい感じであればこのまま続行が良いのかなと思ったのですが･･･いかがでしょうか 🙇

そうだったんですね...!私も勘違いしておりました、失礼しました。
ちなみに、armhfのビルドをこちらでビルドしているとのことですが、特にarmhfのビルドはonnxruntime-rs側で使っていないという認識で間違いないでしょうか？

ひとまずonnxruntime-builderへiOS向けビルドの移行を行います。
その後、移行PRを出してからこちらのPRも変更したいと思います。

Hiroshiba · 2023-04-06T15:22:00Z

特にarmhfのビルドはonnxruntime-rs側で使っていない

そうでした、使っていないんでした。。ちなみにRust移行のときに外れたんですが、まだタスクが残ってる感じでした。
VOICEVOX/voicevox_core#213 (comment)

すみません、いったんわかりやすいようにdraftにさせて頂こうと思います！

build on HyodaKazuaki/onnxruntime-builder to confirm working generate-bindings

HyodaKazuaki · 2023-04-10T10:48:45Z

@Hiroshiba
https://github.com/VOICEVOX/onnxruntime-builder/pull/14でマージしていただいた命名ルールに対応しました。
ただ、現在はこのPRのブランチは1.13.1のものになっており、VOICEVOX/onnxruntime-builderにはまだiOS向けビルドがありません。
そのため、最新のコミットでgenerate-bindingsしようとしても失敗します。
一応、私の方でビルドしたものを使うように仕向けたコミットをee0f161に入れましたので、こちらで動作確認はできます。

このPRはこの後どのように進めればいいでしょうか？

PickledChair · 2023-04-10T12:11:28Z

ただ、現在はこのPRのブランチは1.13.1のものになっており、VOICEVOX/onnxruntime-builderにはまだiOS向けビルドがありません。
そのため、最新のコミットでgenerate-bindingsしようとしても失敗します。

横から失礼します。その通りですね！

コアのリポジトリの方の議論では同時にコアを onnxruntime v1.14.1 に対応させるという流れになっていたと思うので、まず先にその作業をすることになるのかなと思いました。 onnxruntime v1.14.0 を使うことになりました VOICEVOX/onnxruntime-builder#15

以下のような段階を踏むと良さそうかと思いました。もし間違いや考慮不足・説明不足などありましたらご指摘いただければ幸いです。

別 PR で onnxruntime-rs をバージョン ~~1.14.1~~ 1.14.0 に対応させ、先にマージ（参考: onnxruntimeを1.13.1に上げる #14 ）
voicevox_core をバージョン ~~1.14.1~~ 1.14.0 対応の onnxruntime-rs を使うように変更し、テストが通ることを確認する
- 製品版もビルドしてプレリリースを行ない、ローカルで実際に使用できることを確認できるとなお良いかも
~~onnxruntime-builder の 1.14.1 のリリースをやり直して、iOS 向けバイナリを含むようにする~~ onnxruntime-builder の 1.14.0 のリリースを作る
本 PR に master ブランチをマージして作業の続きを行ない、完了させる
- この作業中、 onnxruntimeを1.13.1に上げる #14 でもそうだったのですが、onnxruntime-sys crate の build.rs を変更するコミットを push すると、フォーク先で GitHub Actions を通して generate-bindings が行われ、自動で PR が作られるので、この作業ブランチにそれをマージすることで binding を追加できるはず
- 更新：上記は permission の設定を行わないと失敗するようでした

PickledChair · 2023-04-10T12:44:35Z

最初の

別 PR で onnxruntime-rs をバージョン 1.14.1 に対応

について、試しに作業してみたのですが、onnxruntime-android の v1.14.1 バイナリが存在しない（公開されていない）ために、Android 向けの generate-bindings が失敗しますね……（実は iOS 向け v1.14.1 バイナリも CocoaPods では公開されていない。v1.14.0 向けには Android 版も iOS 版もバイナリが配布されている）。

@Hiroshiba これどうしましょうか……。Android 向けに v1.14.1 バイナリが公開される計画があるのかどうかがわかりません。

PickledChair · 2023-04-10T13:01:53Z

とりあえず思いつく代替案は、v1.14.1 ではなく v1.14.0 向けのバインディングを作ることですね

その場合、onnxruntime-builder の方も 1.14.1 をリリースし直すのではなく、1.14.0 のリリースを新たに作ることになります。

Hiroshiba · 2023-04-10T13:07:14Z

Android

なるほどです。他のonnxruntime使いの人も困りそうなので、然るべき場所で報告してあげると良さそうかなと思いました！
こちらもAndroid版をビルドする手もありそうですが、全体的に1.14.0にするのが手っ取り早そうに思いました。

onnxruntime-builderがバージョン指定できる形になってなかったので、そこの改修が必要そうでした。

Hiroshiba · 2023-04-10T13:17:56Z

このPRはこの後どのように進めればいいでしょうか？

@PickledChair さんが作ってくださった手順を進めつつ、もうbuilder側で1.14.1なり1.14.0なりを作成して、onnxruntime-rs側のiOS対応も進められると良いのかなと思いました！
とりあえずbuilder側で1.14.0作成と1.14.1の再作成しようと思います。ちょっとお時間頂いちゃうかもです。

PickledChair · 2023-04-10T13:30:20Z

とりあえず onnxruntime-builder の方に Issue を建てておきました！ VOICEVOX/onnxruntime-builder#15

HyodaKazuaki · 2023-04-11T10:24:14Z

Android

なるほどです。他のonnxruntime使いの人も困りそうなので、然るべき場所で報告してあげると良さそうかなと思いました！こちらもAndroid版をビルドする手もありそうですが、全体的に1.14.0にするのが手っ取り早そうに思いました。

onnxruntime-builderがバージョン指定できる形になってなかったので、そこの改修が必要そうでした。

報告されていました。
microsoft/onnxruntime#15449

Release Noteにも記載されていましたが、1.14.1はPypiとNugetのみでリリースされたようです。
主にWindowsとPython向けのfixが行われたことが理由のようですね。

Hiroshiba · 2023-04-11T16:43:58Z

おーーーー！！　なるほどです。
こういうことがあるならターゲットごとにバージョン変更しても良いかも･･･？いやでもややこしくなりそうですね･･･。
とりあえず1.14.1版があると嬉しいことをissueにコメントしました。

こちらでの進行はとりあえず1.14.0で進めちゃって、Android版がリリースされたりしたらバージョン上げを検討するのが良いかもと思いました！
1.14.0はちょっと実行が遅い環境もある？っぽいので、正式リリースまでにはバージョン上げたいかもです。（忘れてそう）

HyodaKazuaki · 2023-04-13T13:57:42Z

onnxruntime-rsに1.14.0のonnxruntimeを使う変更 #20 がマージされたので、このPRにも取り込みました。

Hiroshiba

ほぼLGTMです！！

onnxruntime-sys/build.rs

qryxip

試してませんがLGTM

qryxip · 2023-04-14T15:13:21Z

onnxruntime-sys/build.rs

@@ -416,6 +426,7 @@ impl OnnxPrebuiltArchive for Os {
            Os::Linux => Cow::from("linux"),
            Os::MacOs => Cow::from("osx"),
            Os::Android => Cow::from("android"),
+            Os::IOs => Cow::from("ios"),


Rustの命名規則だとIosの方がいいんですが、2行上でnbigaouette氏(オリジナルのonnxruntime-rsの作者)がMacOsと書いちゃっているので統一感のためにここは致し方なし...?

In UpperCamelCase, acronyms and contractions of compound words count as one word

個人的には仕方ないかなと思いました･･･！
本当はMacosが良いんだろうなとも思います。が、まあ直しちゃうとコンフリクトが出てしまうので･･･ 😇

Hiroshiba

LGTM！！

HyodaKazuaki added 13 commits March 27, 2023 17:35

support iOS

bcd180d

add aarch64-apple-ios add aarch64-apple-ios-sim

change iOS library target to ios-arm64 and ios-arm64_x86_64-simulator

75423fc

add compile strategy for only iOS

b666249

change output dir

0df261b

fix iOS compile process

c7e13ee

change build directory change default strategy compile to download use compile strategy for iOS build on GitHub actions

fix action shell

2d3f1b5

fix compiling performance and unused github action

86691fc

fix output directory

164d9a5

change iOS default strategy to download

26619b8

use cocoapods prebuild

fix iOS device target

772df58

add x86_64-apple-ios target and remove static lib

2935b14

remove download strategy for iOS and

c30c6f6

fix x86_64-apple-ios target build add x86_64-apple-ios target bindings

add x86_64-apple-ios binding

adc9201

HyodaKazuaki mentioned this pull request Apr 3, 2023

iOSビルドのサポート VOICEVOX/voicevox_core#459

Closed

6 tasks

Hiroshiba reviewed Apr 6, 2023

View reviewed changes

.github/actions/auto_gen_bind_pr/action.yaml Outdated Show resolved Hide resolved

Hiroshiba marked this pull request as draft April 6, 2023 15:22

HyodaKazuaki mentioned this pull request Apr 8, 2023

iOSビルドの追加 VOICEVOX/onnxruntime-builder#13

Merged

HyodaKazuaki added 4 commits April 9, 2023 19:30

use prebuild instead of compile strategy

082ef93

remove unused simulator os

facd505

remove unused library

652a640

remove version prefix

9350cda

HyodaKazuaki mentioned this pull request Apr 10, 2023

バージョンプレフィックスを削除 VOICEVOX/onnxruntime-builder#14

Merged

HyodaKazuaki added 2 commits April 10, 2023 17:49

fix for iOS build

ee0f161

build on HyodaKazuaki/onnxruntime-builder to confirm working generate-bindings

fix for VOICEVOX organization

1277c6f

PickledChair mentioned this pull request Apr 10, 2023

onnxruntime v1.14.0 向けのバイナリをビルドする VOICEVOX/onnxruntime-builder#15

Closed

This was referenced Apr 10, 2023

バージョン指定を可能にする VOICEVOX/onnxruntime-builder#16

Merged

Android版onnxruntimeのビルドをする？ VOICEVOX/onnxruntime-builder#17

Closed

PickledChair mentioned this pull request Apr 11, 2023

onnxruntimeを1.14.0に上げる #20

Merged

Merge branch 'VOICEVOX:master' into feature/support-aarch64-apple-ios

cc4f328

HyodaKazuaki marked this pull request as ready for review April 13, 2023 13:59

HyodaKazuaki marked this pull request as draft April 13, 2023 14:09

update bingings for iOS

c96e34a

HyodaKazuaki marked this pull request as ready for review April 13, 2023 14:24

Hiroshiba reviewed Apr 14, 2023

View reviewed changes

onnxruntime-sys/build.rs Outdated Show resolved Hide resolved

onnxruntime-sys/build.rs Outdated Show resolved Hide resolved

onnxruntime-sys/build.rs Outdated Show resolved Hide resolved

remove iOS deploy version and add note

692c1dc

qryxip approved these changes Apr 14, 2023

View reviewed changes

qryxip requested a review from PickledChair April 14, 2023 15:16

Hiroshiba approved these changes Apr 15, 2023

View reviewed changes

Hiroshiba merged commit c322c6a into VOICEVOX:master Apr 15, 2023

HyodaKazuaki deleted the feature/support-aarch64-apple-ios branch April 15, 2023 03:22

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

support iOS #19

support iOS #19

HyodaKazuaki commented Apr 3, 2023 •

edited

Loading

Hiroshiba left a comment •

edited

Loading

HyodaKazuaki commented Apr 6, 2023

Hiroshiba commented Apr 6, 2023 •

edited

Loading

HyodaKazuaki commented Apr 10, 2023

PickledChair commented Apr 10, 2023 •

edited

Loading

PickledChair commented Apr 10, 2023 •

edited

Loading

PickledChair commented Apr 10, 2023 •

edited

Loading

Hiroshiba commented Apr 10, 2023

Hiroshiba commented Apr 10, 2023

PickledChair commented Apr 10, 2023

HyodaKazuaki commented Apr 11, 2023

Hiroshiba commented Apr 11, 2023

HyodaKazuaki commented Apr 13, 2023 •

edited

Loading

Hiroshiba left a comment

qryxip left a comment

qryxip Apr 14, 2023

Hiroshiba Apr 15, 2023

Hiroshiba left a comment

support iOS #19

support iOS #19

Conversation

HyodaKazuaki commented Apr 3, 2023 • edited Loading

サポートするRustターゲット

関連Issue

Hiroshiba left a comment • edited Loading

Choose a reason for hiding this comment

HyodaKazuaki commented Apr 6, 2023

Hiroshiba commented Apr 6, 2023 • edited Loading

HyodaKazuaki commented Apr 10, 2023

PickledChair commented Apr 10, 2023 • edited Loading

PickledChair commented Apr 10, 2023 • edited Loading

PickledChair commented Apr 10, 2023 • edited Loading

Hiroshiba commented Apr 10, 2023

Hiroshiba commented Apr 10, 2023

PickledChair commented Apr 10, 2023

HyodaKazuaki commented Apr 11, 2023

Hiroshiba commented Apr 11, 2023

HyodaKazuaki commented Apr 13, 2023 • edited Loading

Hiroshiba left a comment

Choose a reason for hiding this comment

qryxip left a comment

Choose a reason for hiding this comment

qryxip Apr 14, 2023

Choose a reason for hiding this comment

Hiroshiba Apr 15, 2023

Choose a reason for hiding this comment

Hiroshiba left a comment

Choose a reason for hiding this comment

HyodaKazuaki commented Apr 3, 2023 •

edited

Loading

Hiroshiba left a comment •

edited

Loading

Hiroshiba commented Apr 6, 2023 •

edited

Loading

PickledChair commented Apr 10, 2023 •

edited

Loading

PickledChair commented Apr 10, 2023 •

edited

Loading

PickledChair commented Apr 10, 2023 •

edited

Loading

HyodaKazuaki commented Apr 13, 2023 •

edited

Loading