mirror of
https://github.com/saymrwulf/onnxruntime.git
synced 2026-05-14 20:48:00 +00:00
fd8ad9b950
### Description Enable support for building iOS packages/CocoaPods with training API - Add `Training` Package variant and config files in current iOS packaging utilities to enable creation of training packages ### Motivation and Context This PR introduces new `Training` variant in `build_and_assemble_ios_pods.py` script which allows creating pods for iOS with training API enabled. The sample script to build training pods: ``` python3 tools/ci_build/github/apple/build_and_assemble_ios_pods.py --variant Training \ --build-settings-file tools/ci_build/github/apple/default_full_ios_training_framework_build_settings.json \ -b=-- path_to_protoc_exe=<path/to/protoc> ``` Note: build settings file should have `--enable_training` as a build parameter. Simply adding training packaging increases the duration of the Azure pipeline for packaging by 70 minutes. To address this issue, we need to parallelize pod creation. In order not to further strain the pipeline, the changes for training packaging will be added in another PR, which optimizes the packaging pipeline. --------- Co-authored-by: Edward Chen <18449977+edgchen1@users.noreply.github.com>
109 lines
5.1 KiB
Swift
109 lines
5.1 KiB
Swift
// swift-tools-version: 5.6
|
|
// The swift-tools-version declares the minimum version of Swift required to build this package and MUST be the first
|
|
// line of this file. 5.6 is required to support zip files for the pod archive binaryTarget.
|
|
//
|
|
// Copyright (c) Microsoft Corporation. All rights reserved.
|
|
// Licensed under the MIT License.
|
|
//
|
|
// A user of the Swift Package Manager (SPM) package will consume this file directly from the ORT github repository.
|
|
// For context, the end user's config will look something like:
|
|
//
|
|
// dependencies: [
|
|
// .package(url: "https://github.com/microsoft/onnxruntime", branch: "rel-1.15.0"),
|
|
// ...
|
|
// ],
|
|
//
|
|
// NOTE: The direct consumption creates a somewhat complicated setup to 'release' a new version of the ORT SPM package.
|
|
// TBD: how to manage the release process
|
|
|
|
import PackageDescription
|
|
import class Foundation.ProcessInfo
|
|
|
|
let package = Package(
|
|
name: "onnxruntime",
|
|
platforms: [.iOS(.v11)],
|
|
products: [
|
|
.library(name: "onnxruntime",
|
|
type: .static,
|
|
targets: ["OnnxRuntimeBindings"]),
|
|
],
|
|
dependencies: [],
|
|
targets: [
|
|
.target(name: "OnnxRuntimeBindings",
|
|
dependencies: ["onnxruntime"],
|
|
path: "objectivec",
|
|
exclude: ["test", "docs", "ReadMe.md", "format_objc.sh",
|
|
"ort_checkpoint.mm",
|
|
"ort_checkpoint_internal.h",
|
|
"ort_training_session_internal.h",
|
|
"ort_training_session.mm",
|
|
"include/ort_checkpoint.h",
|
|
"include/ort_training_session.h",
|
|
"include/onnxruntime_training.h"],
|
|
cxxSettings: [
|
|
.define("SPM_BUILD"),
|
|
.unsafeFlags(["-std=c++17",
|
|
"-fobjc-arc-exceptions"
|
|
]),
|
|
], linkerSettings: [
|
|
.unsafeFlags(["-ObjC"]),
|
|
]),
|
|
.testTarget(name: "OnnxRuntimeBindingsTests",
|
|
dependencies: ["OnnxRuntimeBindings"],
|
|
path: "swift/OnnxRuntimeBindingsTests",
|
|
resources: [
|
|
.copy("Resources/single_add.basic.ort")
|
|
]),
|
|
]
|
|
)
|
|
|
|
// Add the ORT iOS Pod archive as a binary target.
|
|
//
|
|
// There are 2 scenarios:
|
|
//
|
|
// Release branch of ORT github repo:
|
|
// Target will be set to the released pod archive and its checksum.
|
|
//
|
|
// Any other branch/tag of ORT github repo:
|
|
// Invalid by default. We do not have a pod archive that is guaranteed to work
|
|
// as the objective-c bindings may have changed since the pod archive was released.
|
|
|
|
// CI or local testing where you have built/obtained the iOS Pod archive matching the current source code.
|
|
// Requires the ORT_IOS_POD_LOCAL_PATH environment variable to be set to specify the location of the pod.
|
|
if let pod_archive_path = ProcessInfo.processInfo.environment["ORT_IOS_POD_LOCAL_PATH"] {
|
|
// ORT_IOS_POD_LOCAL_PATH MUST be a path that is relative to Package.swift.
|
|
//
|
|
// To build locally, tools/ci_build/github/apple/build_and_assemble_ios_pods.py can be used
|
|
// See https://onnxruntime.ai/docs/build/custom.html#ios
|
|
// Example command:
|
|
// python3 tools/ci_build/github/apple/build_and_assemble_ios_pods.py \
|
|
// --variant Full \
|
|
// --build-settings-file tools/ci_build/github/apple/default_full_ios_framework_build_settings.json
|
|
//
|
|
// This should produce the pod archive in build/ios_pod_staging, and ORT_IOS_POD_LOCAL_PATH can be set to
|
|
// "build/ios_pod_staging/pod-archive-onnxruntime-c-???.zip" where '???' is replaced by the version info in the
|
|
// actual filename.
|
|
package.targets.append(Target.binaryTarget(name: "onnxruntime", path: pod_archive_path))
|
|
|
|
} else {
|
|
// When creating the release version:
|
|
// - remove the fatalError
|
|
// - uncomment the package.targets.append call
|
|
// - update the major/minor/patch version info in the url
|
|
// - insert the checksum info from the onnxruntime-ios-packaging-pipeline CI's 'Print ORT iOS Pod checksum'
|
|
// stage output (or download the pod archive artifact from the CI and run `shasum -a 256 <path to pod zip>`
|
|
// to manually calculate it).
|
|
// The checksum length and chars should look something like
|
|
// "c89cd106ff02eb3892243acd7c4f2bd8e68c2c94f2751b5e35f98722e10c042b"
|
|
//
|
|
// package.targets.append(
|
|
// Target.binaryTarget(name: "onnxruntime",
|
|
// url: "https://onnxruntimepackages.z14.web.core.windows.net/pod-archive-onnxruntime-c-<major.minor.patch>.zip",
|
|
// checksum: "Insert checksum here")
|
|
// )
|
|
|
|
fatalError("It is not valid to use a non-release branch from https://github.com/microsoft/onnxruntime.\n" +
|
|
"Please use a release branch (e.g. rel-1.15.0), or build the ONNX Runtime iOS pod archive locally " +
|
|
"and set the ORT_IOS_POD_LOCAL_PATH environment variable.\n" +
|
|
"See Package.swift for more information on using a local pod archive.")
|
|
}
|