5bcbbf5373
Summary: *Context:* https://github.com/pytorch/pytorch/issues/53406 added a lint for trailing whitespace at the ends of lines. However, in order to pass FB-internal lints, that PR also had to normalize the trailing newlines in four of the files it touched. This PR adds an OSS lint to normalize trailing newlines. The changes to the following files (made in 54847d0adb9be71be4979cead3d9d4c02160e4cd) are the only manually-written parts of this PR: - `.github/workflows/lint.yml` - `mypy-strict.ini` - `tools/README.md` - `tools/test/test_trailing_newlines.py` - `tools/trailing_newlines.py` I would have liked to make this just a shell one-liner like the other three similar lints, but nothing I could find quite fit the bill. Specifically, all the answers I tried from the following Stack Overflow questions were far too slow (at least a minute and a half to run on this entire repository): - [How to detect file ends in newline?](https://stackoverflow.com/q/38746) - [How do I find files that do not end with a newline/linefeed?](https://stackoverflow.com/q/4631068) - [How to list all files in the Git index without newline at end of file](https://stackoverflow.com/q/27624800) - [Linux - check if there is an empty line at the end of a file [duplicate]](https://stackoverflow.com/q/34943632) - [git ensure newline at end of each file](https://stackoverflow.com/q/57770972) To avoid giving false positives during the few days after this PR is merged, we should probably only merge it after https://github.com/pytorch/pytorch/issues/54967. Pull Request resolved: https://github.com/pytorch/pytorch/pull/54737 Test Plan: Running the shell script from the "Ensure correct trailing newlines" step in the `quick-checks` job of `.github/workflows/lint.yml` should print no output and exit in a fraction of a second with a status of 0. That was not the case prior to this PR, as shown by this failing GHA workflow run on an earlier draft of this PR: - https://github.com/pytorch/pytorch/runs/2197446987?check_suite_focus=true In contrast, this run (after correcting the trailing newlines in this PR) succeeded: - https://github.com/pytorch/pytorch/pull/54737/checks?check_run_id=2197553241 To unit-test `tools/trailing_newlines.py` itself (this is run as part of our "Test tools" GitHub Actions workflow): ``` python tools/test/test_trailing_newlines.py ``` Reviewed By: malfet Differential Revision: D27409736 Pulled By: samestep fbshipit-source-id: 46f565227046b39f68349bbd5633105b2d2e9b19 |
||
|---|---|---|
| .. | ||
| benchmark | ||
| custom_build | ||
| fastlane | ||
| TestApp | ||
| TestApp.xcodeproj | ||
| TestAppTests | ||
| .clang-format | ||
| .gitignore | ||
| bootstrap.sh | ||
| Gemfile | ||
| Gemfile.lock | ||
| Podfile | ||
| README.md | ||
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
- In the PyTorch root directory, run
IOS_ARCH=arm64 ./scripts/build_ios.shto generate the custom build from Master branch - Navigate to the
benchmarkfolder, runpython trace_model.pyto generate your model. - In the same directory, open
config.json. Those are the input parameters you can tweak. - Again, in the same directory, run
ruby setup.rbto setup the XCode project. - 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
- A valid iOS dev certificate installed on your local machine.
- A valid provisioning profile for code signing
- 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