pytorch/ios/TestApp
Jiakai Liu 9a5e9d8cec [pytorch][mobile] change mobile build scripts to build PyTorch by default (#34203)
Summary:
Pull Request resolved: https://github.com/pytorch/pytorch/pull/34203

Currently cmake and mobile build scripts still build libcaffe2 by
default. To build pytorch mobile users have to set environment variable
BUILD_PYTORCH_MOBILE=1 or set cmake option BUILD_CAFFE2_MOBILE=OFF.

PyTorch mobile has been released for a while. It's about time to change
CMake and build scripts to build libtorch by default.

Changed caffe2 CI job to build libcaffe2 by setting BUILD_CAFFE2_MOBILE=1
environment variable. Only found android CI for libcaffe2 - do we ever
have iOS CI for libcaffe2?

Test Plan: Imported from OSS

Differential Revision: D20267274

Pulled By: ljk53

fbshipit-source-id: 9d997032a599c874d62fbcfc4f5d4fbf8323a12e
2020-03-05 23:40:47 -08:00
..
benchmark Mobile Backend: NHWC memory layout + XNNPACK integration. (#33722) 2020-02-24 21:58:56 -08:00
custom_build Add CI scripts for Custom Build (#32316) 2020-01-16 14:46:16 -08:00
fastlane Suppress XCode build warnings (#31000) 2019-12-10 11:37:52 -08:00
TestApp [jit] do the code reorg (#33851) 2020-02-27 13:02:51 -08:00
TestApp.xcodeproj Fix iOS CI (#30327) 2019-12-03 11:24:21 -08:00
TestAppTests Fix iOS CI (#30327) 2019-12-03 11:24:21 -08:00
.clang-format add benchmark code to iOS TestApp (#28405) 2019-10-22 12:52:30 -07:00
.gitignore Suppress XCode build warnings (#31000) 2019-12-10 11:37:52 -08:00
bootstrap.sh Check device connection before running xcodebuild (#28996) 2019-11-02 14:38:08 -07:00
Gemfile Install developer certificate for code signing (#27593) 2019-10-09 20:07:30 -07:00
Gemfile.lock Update Gemfile (#32147) 2020-01-14 14:52:50 -08:00
Podfile Add iOS test app skeleton (#26261) 2019-09-17 11:06:57 -07:00
README.md [pytorch][mobile] change mobile build scripts to build PyTorch by default (#34203) 2020-03-05 23:40:47 -08:00

TestApp

The TestApp is being used for different purposes as described below

Cocoapods

To quickly test our framework in Cocoapods, simply run

pod install

This will pull the latest version of LibTorch from Cocoapods. To run the app, you need to have your model copied to the project as well as a config.json file, which can be found in the benchmark folder.

Circle CI and Fastlane

The TestApp is currently being used as a dummy app by Circle CI for nightly jobs. The challenge comes when testing the arm64 build as we don't have a way to code-sign our TestApp. This is where Fastlane came to rescue. Fastlane is a trendy automation tool for building and managing iOS applications. It also works seamlessly with Circle CI. We are going to leverage the import_certificate action, which can install developer certificates on CI machines. See Fastfile for more details.

For simulator build, we run unit tests as the last step of our CI workflow. Those unit tests can also be run manually via the fastlane scan command.

Benchmark

The benchmark folder contains two scripts that help you setup the benchmark project. The setup.rb does the heavy-lifting jobs of setting up the XCode project, whereas the trace_model.py is a Python script that you can tweak to generate your model for benchmarking. Simply follow the steps below to setup the project

  1. In the PyTorch root directory, run IOS_ARCH=arm64 ./scripts/build_ios.sh to generate the custom build from Master branch
  2. Navigate to the benchmark folder, run python trace_model.py to generate your model.
  3. In the same directory, open config.json. Those are the input parameters you can tweak.
  4. Again, in the same directory, run ruby setup.rb to setup the XCode project.
  5. Open the TestApp.xcodeproj, you're ready to go.

The benchmark code is written in C++, you can use UI_LOG to visualize the log. See benchmark.mm for more details.

bootstrap.sh

For those who want to do perf testing but don't want to touch XCode, bootstrap.sh is the right tool for you. It'll automatically build and install the app on your device. That being said, it does require you to have

  1. A valid iOS dev certificate installed on your local machine.
  2. A valid provisioning profile for code signing
  3. A valid team identifier

To run the script, simply type the command below and make sure your phone is connected via USB.

./bootstrap

Open the app on your device, the benchmark result will be displayed on the screen.

Note This requires ios-deploy to be installed. Please have a look at ios-deploy. To quickly install it, use npm -g i ios-deploy