saymrwulf/onnxruntime
1
0
Fork 0
mirror of https://github.com/saymrwulf/onnxruntime.git synced 2026-07-15 18:23:41 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update macOS and iOS custom build documentation for training (#17223)

Browse source 
### Description
Add instructions for macOS build and training pods

Preview: https://vraspar.github.io/onnxruntime/docs/build/training.html,
https://vraspar.github.io/onnxruntime/docs/build/custom.html#ios

---------

Co-authored-by: Edward Chen <18449977+edgchen1@users.noreply.github.com>
Co-authored-by: Baiju Meswani <baijumeswani@gmail.com>
This commit is contained in:
Vrajang Parikh 2023-08-18 15:09:29 -07:00 committed by GitHub
parent d5d960e6ff
commit de3393b725
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 22 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
docs/build/custom.md vendored
View file

@ -186,6 +186,20 @@ To produce pods for an iOS build, use the [build_and_assemble_ios_pods.py](https
The reduced set of ops in the custom build is specified with the file provided to the `--include_ops_by_config` option. See the current op config used by the pre-built mobile package at [tools/ci_build/github/android/mobile_package.required_operators.config](https://github.com/microsoft/onnxruntime/blob/main/tools/ci_build/github/android/mobile_package.required_operators.config) (Android and iOS pre-built mobile packages share the same config file). You can use this file directly.
The default package does not include the training APIs. To create a training package, add `--enable_training_apis` in the build options file provided to `--build-settings-file` and add the `--variant Training` option when calling `build_and_assemble_ios_pods.py`.
For example:
```bash
# /path/to/build_settings.json is a file that includes the `--enable_training_apis` option
python3 tools/ci_build/github/apple/build_and_assemble_ios_pods.py \
--staging-dir /path/to/staging/dir \
--include-ops-by-config /path/to/ops.config \
--build-settings-file /path/to/build_settings.json \
--variant Training
```
3. Use the local pods.
For example, update the Podfile to use the local onnxruntime-mobile-objc pod instead of the released one:

8
docs/build/training.md vendored
View file

@ -41,6 +41,14 @@ redirect_from: /docs/how-to/build/training
Refer to the [Android build instructions](./android.md) and add the ```--enable_training_apis``` build flag.
d. For MacOS
Refer to the [macOS inference build instructions](./inferencing.md) and add the `--enable_training_apis` build flag.
e. For iOS
Refer to the [iOS build instructions](./ios.md) and add the ```--enable_training_apis``` build flag.
> **Note**
>
> - To build the C# bindings, add the ```--build_nuget``` flag to the build command above.