Skip to content

Document iOS Version Requirement for Core ML Delegate #8264

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
GregoryComer opened this issue Feb 6, 2025 · 3 comments
Open

Document iOS Version Requirement for Core ML Delegate #8264

GregoryComer opened this issue Feb 6, 2025 · 3 comments
Assignees
Labels
module: doc Issues related to documentation, both in docs/ and inlined in code module: ios Issues related to iOS code, build, and execution module: user experience Issues related to reducing friction for users triaged This issue has been looked at a team member, and triaged and prioritized into an appropriate module
Milestone

Comments

@GregoryComer
Copy link
Member

GregoryComer commented Feb 6, 2025

🚀 The feature, motivation and pitch

We should standardize on a minimum supported iOS version for the Core ML delegate, clearly document it, and add CI to ensure that the delegate runs successfully on the minimum version to catch accidental inclusion of APIs or functionality that require later versions. This has come up in the context of internal adoption. From discussion with existing users, iOS 15 may be a reasonable minimum target.

Alternatives

No response

Additional context

No response

RFC (Optional)

No response

cc @shoumikhin @mergennachin @byjlw

@GregoryComer GregoryComer added module: ios Issues related to iOS code, build, and execution module: user experience Issues related to reducing friction for users labels Feb 6, 2025
@github-project-automation github-project-automation bot moved this to To triage in ExecuTorch DevX Feb 6, 2025
@GregoryComer GregoryComer changed the title Standardize On + Document iOS Version Requirement for Core ML Delegate Document iOS Version Requirement for Core ML Delegate Feb 6, 2025
@mergennachin mergennachin added the module: doc Issues related to documentation, both in docs/ and inlined in code label Feb 6, 2025
@digantdesai digantdesai added the triaged This issue has been looked at a team member, and triaged and prioritized into an appropriate module label Feb 6, 2025
@mergennachin mergennachin moved this from To triage to Ready in ExecuTorch DevX Feb 6, 2025
@mergennachin mergennachin added this to the 0.6.0 milestone Feb 6, 2025
@shoumikhin
Copy link
Contributor

For OSS we set the minimal supported version as 17.0 for iOS and 10.15 for macOS.
It's specified in the build script and SwiftPM package, so the users just can't bypass that and will get errors/warnings when trying to integrate, unless modify and build the runtime locally.

Technically, users may get away with lower versions if they don't use some of the more recent APIs. And those are protected with availability guards, so the users will get proper signals if they try to build the runtime for lower version sand still use more modern features at runtime.

E.g. the lower threshold can be theoretically lowered to 15.4 for MPS and 16.0 for Core ML backends, according to the docs.

@mergennachin
Copy link
Contributor

@GregoryComer - are there anything that needs to be done in CI and/or documentations, given what @shoumikhin mentioned above?

@GregoryComer
Copy link
Member Author

@mergennachin To meet our internal commitments, we need to support down to iOS 15. If there is functionality that does not work on older iOS versions, we can document it, but I think the core delegate functionality has to be there. I'd like to also be able to make sure that any OSS development doesn't break internal apps that need to support iOS 15, as that can lead to us getting a sev or UBN. Ideally, I'd like to have some amount of OSS CI running iOS-simulator on iOS 15, if possible.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
module: doc Issues related to documentation, both in docs/ and inlined in code module: ios Issues related to iOS code, build, and execution module: user experience Issues related to reducing friction for users triaged This issue has been looked at a team member, and triaged and prioritized into an appropriate module
Projects
Status: In progress
Development

No branches or pull requests

4 participants