iOS Static Build Pipeline by CatalinVoss · Pull Request #3436 · mozilla/DeepSpeech · GitHub

This PR contributes a static build framework build pipeline for iOS, hopefully helping push #3061 along. Credit goes to @xiaoqunSun for pointing me to bazel's ios_static_framework.

Build the static framework like this:

cd tensorflow

bazel build --verbose_failures --config=ios_arm64 --workspace_status_command="bash native_client/bazel_workspace_status_cmd.sh" --apple_bitcode=embedded --copt=-fembed-bitcode --config=monolithic -c opt //native_client:deepspeech_ios --define=runtime=tflite --copt=-DTFLITE_WITH_RUY_GEMV

# Replace .framework folder in Xcode project
rm -rf ../native_client/swift/deepspeech_ios.framework
unzip bazel-bin/native_client/deepspeech_ios.zip
mv deepspeech_ios.framework ../native_client/swift/

If you want a smaller bundle and don't care about shipping apps with bitcode to Apple, you can drop the --apple_bitcode=embedded --copt=-fembed-bitcode flags.

Then the xcodebuild or Xcode app build should work to build a static framework that can be integrated into apps that can be shipped on the iOS App Store or via Testflight.

I tried my best to update the Taskcluster command, but don't want to overpromise.

I also added a basic Podspec which should provide the starting point for turning this into a Cocoa Pod if anyone wants to tackle submitting that somewhere.

… dynamic lib, never strip swift symbols, add framework search paths, and bring in lstdc++

… trouble with the static build

I tried my best to update the Taskcluster command, but don't want to overpromise.

Please @CatalinVoss, feel free to push as much as you need to complete taskcluster green, do not worry about abusing the resources: current usage is quite low, and we have implemented back in august optimizations that ensures high usages do not results in too high costs. Current figures shows this has been successfull, and your PR is more than welcome, so push as much as you need.

@lissyx that's good to know. OK, thanks.

… no longer a thing here. I suppose we could add a step to package the iOS static lib instead.

I think we're good on TC?

I think we're good on TC?

There were à few failures but its all green after rerun. I'll gave à look tomorrow, hopefully. Thanks !

Yeah those didn't look related to me. OK

Yeah those didn't look related to me. OK

They were not, but they were blocking executing a lot of the tests :)

@CatalinVoss Looks good, there were two things I'm unsure about, please let us know if you need further changes or if that is good to go.

Also @reuben can correct me but I think we would like to have that on r0.9 as well ?

I don't think so. Not suitable for a point release in its current state. Would like to get more testing on it. I'll take a closer look at the PR as well this week.

Looks like I don't have permissions to re-trigger that one failing windows test, but it doesn't look related

Looks like I don't have permissions to re-trigger that one failing windows test, but it doesn't look related

Yeah dont worry about this one, it's past deadline Anyway and it's just an intermittent

I have a few minor comments that need to be addressed before merging but this looks great! Great find with ios_static_framework, this ended up being much simpler than I expected.

This reverts commit 3e1922e.

@CatalinVoss Sorry, but valgrind metadata tests on linux shows a memory leak regression: https://community-tc.services.mozilla.com/tasks/VizPwDWmRa-rx6i2f2z_1w/runs/0/logs/https%3A%2F%2Fcommunity-tc.services.mozilla.com%2Fapi%2Fqueue%2Fv1%2Ftask%2FVizPwDWmRa-rx6i2f2z_1w%2Fruns%2F0%2Fartifacts%2Fpublic%252Fvalgrind_extended.log

@CatalinVoss Sorry, but valgrind metadata tests on linux shows a memory leak regression: https://community-tc.services.mozilla.com/tasks/VizPwDWmRa-rx6i2f2z_1w/runs/0/logs/https%3A%2F%2Fcommunity-tc.services.mozilla.com%2Fapi%2Fqueue%2Fv1%2Ftask%2FVizPwDWmRa-rx6i2f2z_1w%2Fruns%2F0%2Fartifacts%2Fpublic%252Fvalgrind_extended.log

@CatalinVoss It might just be some false-positive from Valgrind:

==4364== LEAK SUMMARY:
==4364==    definitely lost: 0 bytes in 0 blocks
==4364==    indirectly lost: 0 bytes in 0 blocks
==4364==      possibly lost: 0 bytes in 0 blocks
==4364==    still reachable: 96 bytes in 2 blocks
==4364==                       of which reachable via heuristic:
==4364==                         newarray           : 9,280 bytes in 11 blocks

And you would just have to update the exclusion lists: https://github.com/mozilla/DeepSpeech/blob/master/taskcluster/tc-valgrind-utils.sh#L5-L9

Looks like re-adding the flags that were dropped when moving from tf_cc_shared_object to cc_library fixed it: #3451

Merged with the fix. Thanks @CatalinVoss!

(Please delete the upstream branch once you're done working on it)

Thank you for that!!

CatalinVoss added 10 commits November 23, 2020 18:32

Set up additional deepspeech_ios target with static build steps

d7e1dae

Xcode config: lock swift version at 5.0, bundle framework rather than…

b31c529

… dynamic lib, never strip swift symbols, add framework search paths, and bring in lstdc++

Runtime schema config: disable the main thread checker as this causes…

321f533

… trouble with the static build

Update model versions to 0.9.1

4387f2e

Remove libdeepspeech.so from example app bundling steps

1d151f1

Swift lib embed settings that are somehow essential

034fb8b

Attempt to adjust taskcluster build steps

1533846

Add a basic podspec

1a428b4

Add framework to gitignore

c7b4474

Fix podspec version code

d1d1ed9

lissyx reviewed Nov 24, 2020

View reviewed changes

Comment thread taskcluster/tc-build-utils.sh Outdated

Attempt to fix taskcluster unzip step

63f879b

CatalinVoss added 3 commits November 24, 2020 19:19

Switch deepspeech targets for iOS build

11acd17

Try doing this unzip in one step

c6dc9a8

Remove packaging steps for unneeded stuff because libdeepspeech.so is…

fcb1781

… no longer a thing here. I suppose we could add a step to package the iOS static lib instead.

lissyx reviewed Nov 26, 2020

View reviewed changes

Comment thread native_client/swift/deepspeech-ios.podspec Outdated

lissyx reviewed Nov 26, 2020

View reviewed changes

Comment thread native_client/swift/deepspeech-ios.podspec Outdated

lissyx approved these changes Nov 26, 2020

View reviewed changes

reuben approved these changes Dec 1, 2020

View reviewed changes

Comment thread native_client/swift/deepspeech-ios.podspec Outdated

Comment thread native_client/BUILD Outdated

Comment thread native_client/BUILD Outdated

Fix podspec version

b910b69

CatalinVoss added 5 commits December 3, 2020 19:00

Set up podspec relative assuming a clone from the repo root

9895d3c

Remove space in iOS package step

3e1922e

Fix buildfile nit

ae2a0a9

Link stdc++ in explicitly with iOS build only

47c3bf3

Revert "Remove space in iOS package step"

31a4eab

This reverts commit 3e1922e.

reuben closed this in bc07842 Dec 4, 2020

CatalinVoss deleted the ios-static-build branch December 4, 2020 18:30

zaptrem mentioned this pull request Dec 27, 2020

Swift/iOS wrapper for TFLite libdeepspeech #3061

Open

11 tasks

zaptrem mentioned this pull request Feb 12, 2021

Fix incompatible Swift module error #3527

Merged

erksch mentioned this pull request May 13, 2021

MinimumIOSVersion 13.5 #3646

Closed

This was referenced May 23, 2021

Set iOS deployment target to 9.0 erksch/STT#1

Merged

Set iOS deployment target to 9.0 coqui-ai/STT#1874

Merged

Boya-Na mentioned this pull request Aug 13, 2021

Crash with Deployment on mobile device #3678

Open

Boya-Na mentioned this pull request Apr 30, 2024

build libdeepspeech.so failed for iOS #3794

Open

iOS Static Build Pipeline by CatalinVoss · Pull Request #3436 · mozilla/DeepSpeech · GitHub

iOS Static Build Pipeline - #3436

iOS Static Build Pipeline#3436CatalinVoss wants to merge 20 commits intomastermozilla/DeepSpeech:masterfrom ios-static-buildmozilla/DeepSpeech:ios-static-buildCopy head branch name to clipboard

Conversation

CatalinVoss commented Nov 24, 2020

Uh oh!

Uh oh!

lissyx commented Nov 24, 2020

Uh oh!

CatalinVoss commented Nov 25, 2020

Uh oh!

CatalinVoss commented Nov 25, 2020

Uh oh!

lissyx commented Nov 25, 2020

Uh oh!

CatalinVoss commented Nov 25, 2020

Uh oh!

lissyx commented Nov 26, 2020

Uh oh!

Uh oh!

Uh oh!

lissyx commented Nov 26, 2020

Uh oh!

reuben commented Nov 26, 2020

Uh oh!

CatalinVoss commented Nov 26, 2020

Uh oh!

lissyx commented Nov 26, 2020

Uh oh!

reuben left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lissyx commented Dec 4, 2020

Uh oh!

lissyx commented Dec 4, 2020

Uh oh!

reuben commented Dec 4, 2020

Uh oh!

reuben commented Dec 4, 2020

Uh oh!

reuben commented Dec 4, 2020

Uh oh!

CatalinVoss commented Dec 4, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

iOS Static Build Pipeline#3436
CatalinVoss wants to merge 20 commits into
masterfrom
ios-static-build