Fix tests compilation on sdk < 14.4 (#2484)

cymbalrush · facebook-github-bot · commit 7edd2fa2da8f · 2024-03-18T09:24:04.000-07:00
Summary: The delegate tests are failing compilation on macOS sdk < 14.4, added header check to make sure that MLComputePlan changes are not compiled on lower sdks. Tested on macOS sdk 14.4 and sdk 14.2. Pull Request resolved: #2484 Reviewed By: digantdesai Differential Revision: D55018113 Pulled By: shoumikhin fbshipit-source-id: d61031c9607db6c61bac3a9cc42b5c4f398b44d8
diff --git a/backends/apple/coreml/runtime/sdk/ETCoreMLModelProfiler.h b/backends/apple/coreml/runtime/sdk/ETCoreMLModelProfiler.h
@@ -6,15 +6,19 @@
 // Please refer to the license found in the LICENSE file in the root directory of the source tree.
 
 #import <CoreML/CoreML.h>
-
-#import "ETCoreMLPair.h"
+#import <ETCoreMLPair.h>
+#import <TargetConditionals.h>
 
 @class ETCoreMLModel;
 @class ETCoreMLModelStructurePath;
 @class ETCoreMLOperationProfilingInfo;
 
 typedef NSDictionary<ETCoreMLModelStructurePath*, ETCoreMLOperationProfilingInfo*> ETCoreMLModelProfilingResult;
 
+#if !defined(MODEL_PROFILING_IS_AVAILABLE) && __has_include(<CoreML/MLComputePlan.h>)
+#define MODEL_PROFILING_IS_AVAILABLE 1
+#endif
+
 NS_ASSUME_NONNULL_BEGIN
 /// A class responsible for profiling a model.
 __attribute__((objc_subclassing_restricted)) @interface ETCoreMLModelProfiler : NSObject
diff --git a/backends/apple/coreml/runtime/sdk/ETCoreMLModelProfiler.mm b/backends/apple/coreml/runtime/sdk/ETCoreMLModelProfiler.mm
@@ -19,6 +19,8 @@
 namespace  {
 using namespace executorchcoreml::modelstructure;
 
+#if MODEL_PROFILING_IS_AVAILABLE
+
 API_AVAILABLE(macos(14.4), ios(17.4), tvos(17.4), watchos(10.4))
 MLComputePlan *_Nullable get_compute_plan_of_model_at_url(NSURL *model_url,
                                                           MLModelConfiguration *configuration,
@@ -212,20 +214,24 @@ void set_model_outputs(id<MLFeatureProvider> output_features,
     
     *model_outputs = values;
 }
+
+#endif
+
 }
 
-API_AVAILABLE(macos(14.4), ios(17.4), tvos(17.4), watchos(10.4))
 @interface ETCoreMLModelProfiler ()
 /// The CoreML model.
 @property (readonly, strong, nonatomic) MLModel *model;
 /// The model output names.
 @property (readonly, copy, nonatomic) NSOrderedSet<NSString *> *outputNames;
+#if MODEL_PROFILING_IS_AVAILABLE
 /// The compute plan.
-@property (readonly, strong, nonatomic) MLComputePlan *computePlan;
+@property (readonly, strong, nonatomic) MLComputePlan *computePlan API_AVAILABLE(macos(14.4), ios(17.4), tvos(17.4), watchos(10.4));
+/// The topologically sorted operations.
+@property (readonly, copy, nonatomic) NSArray<MLModelStructureProgramOperation *> *topologicallySortedOperations API_AVAILABLE(macos(14.4), ios(17.4), tvos(17.4), watchos(10.4));
+#endif
 /// The mapping from operation to it's path in the model structure.
 @property (readonly, strong, nonatomic) NSDictionary<NSValue *, ETCoreMLModelStructurePath *> *operationToPathMap;
-/// The topologically sorted operations.
-@property (readonly, copy, nonatomic) NSArray<MLModelStructureProgramOperation *> *topologicallySortedOperations;
 /// The profiling infos for all the operations.
 @property (readonly, copy, nonatomic) NSDictionary<ETCoreMLModelStructurePath *, ETCoreMLOperationProfilingInfo *> *profilingInfos;
 
@@ -237,6 +243,7 @@ - (nullable instancetype)initWithCompiledModelAsset:(ETCoreMLAsset *)compiledMod
                                         outputNames:(NSOrderedSet<NSString *> *)outputNames
                                       configuration:(MLModelConfiguration *)configuration
                                               error:(NSError * __autoreleasing *)error  {
+#if MODEL_PROFILING_IS_AVAILABLE
     if (@available(macOS 14.4, iOS 17.4, tvOS 17.4, watchOS 10.4, *)) {
         NSURL *compiledModelURL = compiledModelAsset.contentURL;
         MLComputePlan *computePlan = get_compute_plan_of_model_at_url(compiledModelURL,
@@ -282,20 +289,21 @@ - (nullable instancetype)initWithCompiledModelAsset:(ETCoreMLAsset *)compiledMod
         }
         
         return self;
-    } else {
-        ETCoreMLLogErrorAndSetNSError(error,
-                                      ETCoreMLErrorCorruptedModel,
-                                      "%@: Model profiling is only available for macOS >= 14.4, iOS >= 17.4, tvOS >= 17.4 and watchOS >= 10.4.",
-                                      NSStringFromClass(self.class));
-        return nil;
     }
+#endif
+    ETCoreMLLogErrorAndSetNSError(error,
+                                  ETCoreMLErrorCorruptedModel,
+                                  "%@: Model profiling is only available for macOS >= 14.4, iOS >= 17.4, tvOS >= 17.4 and watchOS >= 10.4.",
+                                  NSStringFromClass(self.class));
+    return nil;
 }
 
 - (nullable ETCoreMLModelProfilingResult *)profilingInfoForOperationsAtPaths:(NSArray<ETCoreMLModelStructurePath *> *)paths
                                                                      options:(MLPredictionOptions *)options
                                                                       inputs:(id<MLFeatureProvider>)inputs
                                                                 modelOutputs:(NSArray<MLMultiArray *> *_Nullable __autoreleasing *_Nonnull)modelOutputs
                                                                        error:(NSError* __autoreleasing *)error {
+#if MODEL_PROFILING_IS_AVAILABLE
     uint64_t modelExecutionStartTime = mach_absolute_time();
     id<MLFeatureProvider> outputFeatures = [self.model predictionFromFeatures:inputs options:options error:error];
     uint64_t modelExecutionEndTime = mach_absolute_time();
@@ -319,14 +327,15 @@ - (nullable ETCoreMLModelProfilingResult *)profilingInfoForOperationsAtPaths:(NS
         
         return profilingInfos;
     }
-    
+#endif
     return nil;
 }
 
 - (nullable ETCoreMLModelProfilingResult *)profilingInfoForAllOperationsWithOptions:(MLPredictionOptions *)options
                                                                              inputs:(id<MLFeatureProvider>)inputs
                                                                        modelOutputs:(NSArray<MLMultiArray *> *_Nullable __autoreleasing *_Nonnull)modelOutputs
                                                                               error:(NSError* __autoreleasing *)error {
+#if MODEL_PROFILING_IS_AVAILABLE
     if (@available(macOS 14.4, iOS 17.4, tvOS 17.4, watchOS 10.4, *)) {
         __block NSMutableArray<ETCoreMLModelStructurePath *> *paths = [NSMutableArray array];
         visit_program_operation(self.computePlan.modelStructure, ^BOOL(MLModelStructureProgramOperation *operation, ETCoreMLModelStructurePath *path) {
@@ -342,7 +351,7 @@ - (nullable ETCoreMLModelProfilingResult *)profilingInfoForAllOperationsWithOpti
                                           modelOutputs:modelOutputs
                                                  error:error];
     }
-    
+#endif
     return nil;
 }
 
diff --git a/backends/apple/coreml/runtime/test/ETCoreMLModelProfilerTests.mm b/backends/apple/coreml/runtime/test/ETCoreMLModelProfilerTests.mm
@@ -8,6 +8,7 @@
 
 #import <XCTest/XCTest.h>
 #import <ETCoreMLModelAnalyzer.h>
+#import <ETCoreMLModelProfiler.h>
 #import <ETCoreMLOperationProfilingInfo.h>
 #import <ETCoreMLModelStructurePath.h>
 #import <model_logging_options.h>
@@ -97,7 +98,8 @@ - (void)profileModelWithName:(NSString *)modelName
 }
 
 - (void)testAddProgramProfiling {
-    if (@available(macOS 14.4, iOS 17.4, tvOS 17.4, watchOS 10.4, *)) {
+#if MODEL_PROFILING_IS_AVAILABLE
+    if (@available(macOS 14.4, iOS 17.4, watchOS 10.4, tvOS 17.4, *)) {
         NotifyFn notify = [](NSDictionary<ETCoreMLModelStructurePath *, ETCoreMLOperationProfilingInfo *> *profilingResult,
                              NSDictionary<ETCoreMLModelStructurePath *, NSString *> *__unused pathToSymbolNameMap) {
             // There are 3 add ops, we verify that the profiling info exists for the ops.
@@ -110,9 +112,13 @@ - (void)testAddProgramProfiling {
                repeatedInputValues:@[@(1), @(2)]
                             notify:notify];
     }
+#else
+    XCTSkip(@"Model profiling is only available on macOS 14.4, iOS 17.4, tvOS 17.4, and watchOS 10.4.");
+#endif
 }
 
 - (void)testMulProgramProfiling {
+#if MODEL_PROFILING_IS_AVAILABLE
     if (@available(macOS 14.4, iOS 17.4, tvOS 17.4, watchOS 10.4, *)) {
         NotifyFn notify = [](NSDictionary<ETCoreMLModelStructurePath *, ETCoreMLOperationProfilingInfo *> *profilingResult,
                              NSDictionary<ETCoreMLModelStructurePath *, NSString *> *__unused pathToSymbolNameMap) {
@@ -124,9 +130,13 @@ - (void)testMulProgramProfiling {
                repeatedInputValues:@[@(1), @(2)]
                             notify:notify];
     }
+#else
+    XCTSkip(@"Model profiling is only available on macOS 14.4, iOS 17.4, tvOS 17.4, and watchOS 10.4.");
+#endif
 }
 
 - (void)testMV3ProgramProfiling {
+#if MODEL_PROFILING_IS_AVAILABLE
     if (@available(macOS 14.4, iOS 17.4, tvOS 17.4, watchOS 10.4, *)) {
         NotifyFn notify = [](NSDictionary<ETCoreMLModelStructurePath *, ETCoreMLOperationProfilingInfo *> *profilingResult,
                              NSDictionary<ETCoreMLModelStructurePath *, NSString *> *__unused pathToSymbolNameMap) {
@@ -143,6 +153,9 @@ - (void)testMV3ProgramProfiling {
                repeatedInputValues:@[@(1), @(2)]
                             notify:notify];
     }
+#else
+    XCTSkip(@"Model profiling is only available on macOS 14.4, iOS 17.4, tvOS 17.4, and watchOS 10.4.");
+#endif
 }
 
 @end
