data path support for ios

Author: lucylq

extension/apple/ExecuTorch/Exported/ExecuTorchModule.h

@@ -20,21 +20,20 @@ __attribute__((deprecated("This API is experimental.")))
 @interface ExecuTorchTensorMetadata : NSObject
 
 /** The size of each dimension. */
-@property (nonatomic, readonly) NSArray<NSNumber *> *shape
-    NS_REFINED_FOR_SWIFT;
+@property(nonatomic, readonly) NSArray<NSNumber *> *shape NS_REFINED_FOR_SWIFT;
 
 /** The order in which dimensions are laid out. */
-@property (nonatomic, readonly) NSArray<NSNumber *> *dimensionOrder
-    NS_REFINED_FOR_SWIFT;
+@property(nonatomic, readonly)
+    NSArray<NSNumber *> *dimensionOrder NS_REFINED_FOR_SWIFT;
 
 /** The scalar type of each element in the tensor. */
-@property (nonatomic, readonly) ExecuTorchDataType dataType;
+@property(nonatomic, readonly) ExecuTorchDataType dataType;
 
 /** YES if the runtime pre-allocated memory for this tensor. */
-@property (nonatomic, readonly) BOOL isMemoryPlanned;
+@property(nonatomic, readonly) BOOL isMemoryPlanned;
 
 /** The (optional) user-visible name of this tensor (may be empty) */
-@property (nonatomic, readonly) NSString *name;
+@property(nonatomic, readonly) NSString *name;
 
 + (instancetype)new NS_UNAVAILABLE;
 - (instancetype)init NS_UNAVAILABLE;
@@ -51,42 +50,45 @@ __attribute__((deprecated("This API is experimental.")))
 @interface ExecuTorchMethodMetadata : NSObject
 
 /** The method’s name. */
-@property (nonatomic, readonly) NSString *name;
+@property(nonatomic, readonly) NSString *name;
 
 /** An array of ExecuTorchValueTag raw values, one per declared input. */
-@property (nonatomic, readonly) NSArray<NSNumber *> *inputValueTags
-    NS_REFINED_FOR_SWIFT;
+@property(nonatomic, readonly)
+    NSArray<NSNumber *> *inputValueTags NS_REFINED_FOR_SWIFT;
 
 /** An array of ExecuTorchValueTag raw values, one per declared output. */
-@property (nonatomic, readonly) NSArray<NSNumber *> *outputValueTags
-    NS_REFINED_FOR_SWIFT;
+@property(nonatomic, readonly)
+    NSArray<NSNumber *> *outputValueTags NS_REFINED_FOR_SWIFT;
 
 /**
  * Mapping from input-index to TensorMetadata.
  * Only present for those indices whose tag == .tensor
  */
-@property (nonatomic, readonly) NSDictionary<NSNumber *, ExecuTorchTensorMetadata *> *inputTensorMetadata
-    NS_REFINED_FOR_SWIFT;
+@property(nonatomic, readonly)
+    NSDictionary<NSNumber *, ExecuTorchTensorMetadata *> *inputTensorMetadata
+        NS_REFINED_FOR_SWIFT;
 
 /**
  * Mapping from output-index to TensorMetadata.
  * Only present for those indices whose tag == .tensor
  */
-@property (nonatomic, readonly) NSDictionary<NSNumber *, ExecuTorchTensorMetadata *> *outputTensorMetadata
-    NS_REFINED_FOR_SWIFT;
+@property(nonatomic, readonly)
+    NSDictionary<NSNumber *, ExecuTorchTensorMetadata *> *outputTensorMetadata
+        NS_REFINED_FOR_SWIFT;
 
 /** A list of attribute TensorsMetadata. */
-@property (nonatomic, readonly) NSArray<ExecuTorchTensorMetadata *> *attributeTensorMetadata;
+@property(nonatomic, readonly)
+    NSArray<ExecuTorchTensorMetadata *> *attributeTensorMetadata;
 
 /** A list of memory-planned buffer sizes. */
-@property (nonatomic, readonly) NSArray<NSNumber *> *memoryPlannedBufferSizes
-    NS_REFINED_FOR_SWIFT;
+@property(nonatomic, readonly)
+    NSArray<NSNumber *> *memoryPlannedBufferSizes NS_REFINED_FOR_SWIFT;
 
 /** Names of all backends this method can run on. */
-@property (nonatomic, readonly) NSArray<NSString *> *backendNames;
+@property(nonatomic, readonly) NSArray<NSString *> *backendNames;
 
 /** Total number of low-level instructions in this method’s body. */
-@property (nonatomic, readonly) NSInteger instructionCount;
+@property(nonatomic, readonly) NSInteger instructionCount;
 
 + (instancetype)new NS_UNAVAILABLE;
 - (instancetype)init NS_UNAVAILABLE;
@@ -111,33 +113,53 @@ typedef NS_ENUM(NSInteger, ExecuTorchModuleLoadMode) {
  * runtime/executor/program.h
  */
 typedef NS_ENUM(uint8_t, ExecuTorchVerification) {
-    ExecuTorchVerificationMinimal,
-    ExecuTorchVerificationInternalConsistency,
+  ExecuTorchVerificationMinimal,
+  ExecuTorchVerificationInternalConsistency,
 } NS_SWIFT_NAME(ModuleVerification);
 
 /**
  * Represents a module that encapsulates an ExecuTorch program.
- * This class is a facade for loading programs and executing methods within them.
+ * This class is a facade for loading programs and executing methods within
+ * them.
  */
 NS_SWIFT_NAME(Module)
 __attribute__((deprecated("This API is experimental.")))
 @interface ExecuTorchModule : NSObject
 
 /**
- * Initializes a module with a file path and a specified load mode.
+ * Initializes a module with a file path, data path, and a specified load mode.
  *
- * @param filePath A string representing the path to the ExecuTorch program file.
- * @param loadMode A value from ExecuTorchModuleLoadMode that determines the file loading behavior.
+ * @param filePath A string representing the path to the ExecuTorch program
+ * file.
+ * @param dataPath A string representing the path to the data file containing
+ * external constants/tensors.
+ * @param loadMode A value from ExecuTorchModuleLoadMode that determines the
+ * file loading behavior.
  * @return An initialized ExecuTorchModule instance.
  */
 - (instancetype)initWithFilePath:(NSString *)filePath
+                        dataPath:(NSString *)dataPath
                         loadMode:(ExecuTorchModuleLoadMode)loadMode
     NS_DESIGNATED_INITIALIZER;
 
 /**
- * Initializes a module with a file path using the default load mode (File mode).
+ * Initializes a module with a file path and a specified load mode.
+ *
+ * @param filePath A string representing the path to the ExecuTorch program
+ * file.
+ * @param loadMode A value from ExecuTorchModuleLoadMode that determines the
+ * file loading behavior.
+ * @return An initialized ExecuTorchModule instance.
+ */
+- (instancetype)initWithFilePath:(NSString *)filePath
+                        loadMode:(ExecuTorchModuleLoadMode)loadMode;
+
+/**
+ * Initializes a module with a file path using the default load mode (File
+ * mode).
  *
- * @param filePath A string representing the path to the ExecuTorch program file.
+ * @param filePath A string representing the path to the ExecuTorch program
+ * file.
  * @return An initialized ExecuTorchModule instance.
  */
 - (instancetype)initWithFilePath:(NSString *)filePath;
@@ -146,7 +168,8 @@ __attribute__((deprecated("This API is experimental.")))
  * Loads the module’s program using the specified verification level.
  *
  * @param verification The verification level to apply when loading the program.
- * @param error A pointer to an NSError pointer that will be set if an error occurs.
+ * @param error A pointer to an NSError pointer that will be set if an error
+ * occurs.
  * @return YES if the program was successfully loaded; otherwise, NO.
  */
 - (BOOL)loadWithVerification:(ExecuTorchVerification)verification
@@ -155,9 +178,11 @@ __attribute__((deprecated("This API is experimental.")))
 /**
  * Loads the module’s program using minimal verification.
  *
- * This is a convenience overload that defaults the verification level to Minimal.
+ * This is a convenience overload that defaults the verification level to
+ * Minimal.
  *
- * @param error A pointer to an NSError pointer that will be set if an error occurs.
+ * @param error A pointer to an NSError pointer that will be set if an error
+ * occurs.
  * @return YES if the program was successfully loaded; otherwise, NO.
  */
 - (BOOL)load:(NSError **)error;
@@ -198,8 +223,8 @@ __attribute__((deprecated("This API is experimental.")))
 /**
  * Retrieves the set of method names available in the loaded program.
  *
- * The method names are returned as an unordered set of strings. The program and methods
- * are loaded as needed.
+ * The method names are returned as an unordered set of strings. The program and
+ * methods are loaded as needed.
  *
  * @param error A pointer to an NSError pointer that is set if an error occurs.
  * @return An unordered set of method names, or nil in case of an error.
@@ -215,10 +240,11 @@ __attribute__((deprecated("This API is experimental.")))
  *
  * @param methodName A string representing the method name.
  * @param error A pointer to an NSError pointer that is set if an error occurs.
- * @return An ExecuTorchMethodMetadata object on success, or nil if the method isn’t found or a load error occurred.
+ * @return An ExecuTorchMethodMetadata object on success, or nil if the method
+ * isn’t found or a load error occurred.
  */
- - (nullable ExecuTorchMethodMetadata *)methodMetadata:(NSString *)methodName
-                                                 error:(NSError **)error
+- (nullable ExecuTorchMethodMetadata *)methodMetadata:(NSString *)methodName
+                                                error:(NSError **)error
     NS_RETURNS_RETAINED;
 
 /**
@@ -229,13 +255,13 @@ __attribute__((deprecated("This API is experimental.")))
  * @param methodName A string representing the method name.
  * @param values An NSArray of ExecuTorchValue objects representing the inputs.
  * @param error A pointer to an NSError pointer that is set if an error occurs.
- * @return An NSArray of ExecuTorchValue objects representing the outputs, or nil in case of an error.
+ * @return An NSArray of ExecuTorchValue objects representing the outputs, or
+ * nil in case of an error.
  */
-- (nullable NSArray<ExecuTorchValue *> *)executeMethod:(NSString *)methodName
-                                            withInputs:(NSArray<ExecuTorchValue *> *)values
-                                                 error:(NSError **)error
-    NS_REFINED_FOR_SWIFT
-    NS_RETURNS_RETAINED;
+- (nullable NSArray<ExecuTorchValue *> *)
+    executeMethod:(NSString *)methodName
+       withInputs:(NSArray<ExecuTorchValue *> *)values
+            error:(NSError **)error NS_REFINED_FOR_SWIFT NS_RETURNS_RETAINED;
 
 /**
  * Executes a specific method with the provided single input value.
@@ -245,13 +271,13 @@ __attribute__((deprecated("This API is experimental.")))
  * @param methodName A string representing the method name.
  * @param value An ExecuTorchValue object representing the input.
  * @param error A pointer to an NSError pointer that is set if an error occurs.
- * @return An NSArray of ExecuTorchValue objects representing the outputs, or nil in case of an error.
+ * @return An NSArray of ExecuTorchValue objects representing the outputs, or
+ * nil in case of an error.
  */
 - (nullable NSArray<ExecuTorchValue *> *)executeMethod:(NSString *)methodName
                                              withInput:(ExecuTorchValue *)value
                                                  error:(NSError **)error
-    NS_SWIFT_UNAVAILABLE("")
-    NS_RETURNS_RETAINED;
+    NS_SWIFT_UNAVAILABLE("")NS_RETURNS_RETAINED;
 
 /**
  * Executes a specific method with no input values.
@@ -260,28 +286,29 @@ __attribute__((deprecated("This API is experimental.")))
  *
  * @param methodName A string representing the method name.
  * @param error A pointer to an NSError pointer that is set if an error occurs.
- * @return An NSArray of ExecuTorchValue objects representing the outputs, or nil in case of an error.
+ * @return An NSArray of ExecuTorchValue objects representing the outputs, or
+ * nil in case of an error.
  */
 - (nullable NSArray<ExecuTorchValue *> *)executeMethod:(NSString *)methodName
                                                  error:(NSError **)error
-    NS_SWIFT_NAME(execute(_:))
-    NS_RETURNS_RETAINED;
+    NS_SWIFT_NAME(execute(_:)) NS_RETURNS_RETAINED;
 
 /**
  * Executes a specific method with the provided input tensors.
  *
  * The method is loaded on demand if not already loaded.
  *
  * @param methodName A string representing the method name.
- * @param tensors An NSArray of ExecuTorchTensor objects representing the inputs.
+ * @param tensors An NSArray of ExecuTorchTensor objects representing the
+ * inputs.
  * @param error A pointer to an NSError pointer that is set if an error occurs.
- * @return An NSArray of ExecuTorchValue objects representing the outputs, or nil in case of an error.
+ * @return An NSArray of ExecuTorchValue objects representing the outputs, or
+ * nil in case of an error.
  */
-- (nullable NSArray<ExecuTorchValue *> *)executeMethod:(NSString *)methodName
-                                           withTensors:(NSArray<ExecuTorchTensor *> *)tensors
-                                                 error:(NSError **)error
-    NS_SWIFT_UNAVAILABLE("")
-    NS_RETURNS_RETAINED;
+- (nullable NSArray<ExecuTorchValue *> *)
+    executeMethod:(NSString *)methodName
+      withTensors:(NSArray<ExecuTorchTensor *> *)tensors
+            error:(NSError **)error NS_SWIFT_UNAVAILABLE("")NS_RETURNS_RETAINED;
 
 /**
  * Executes a specific method with the provided single input tensor.
@@ -291,80 +318,92 @@ __attribute__((deprecated("This API is experimental.")))
  * @param methodName A string representing the method name.
  * @param tensor An ExecuTorchTensor object representing the input.
  * @param error A pointer to an NSError pointer that is set if an error occurs.
- * @return An NSArray of ExecuTorchValue objects representing the outputs, or nil in case of an error.
+ * @return An NSArray of ExecuTorchValue objects representing the outputs, or
+ * nil in case of an error.
  */
 - (nullable NSArray<ExecuTorchValue *> *)executeMethod:(NSString *)methodName
-                                            withTensor:(ExecuTorchTensor *)tensor
+                                            withTensor:
+                                                (ExecuTorchTensor *)tensor
                                                  error:(NSError **)error
-    NS_SWIFT_UNAVAILABLE("")
-    NS_RETURNS_RETAINED;
+    NS_SWIFT_UNAVAILABLE("")NS_RETURNS_RETAINED;
 
 /**
  * Executes the "forward" method with the provided input values.
  *
- * This is a convenience method that calls the executeMethod with "forward" as the method name.
+ * This is a convenience method that calls the executeMethod with "forward" as
+ * the method name.
  *
  * @param values An NSArray of ExecuTorchValue objects representing the inputs.
  * @param error A pointer to an NSError pointer that is set if an error occurs.
- * @return An NSArray of ExecuTorchValue objects representing the outputs, or nil in case of an error.
+ * @return An NSArray of ExecuTorchValue objects representing the outputs, or
+ * nil in case of an error.
  */
-- (nullable NSArray<ExecuTorchValue *> *)forwardWithInputs:(NSArray<ExecuTorchValue *> *)values
-                                                     error:(NSError **)error
-    NS_SWIFT_UNAVAILABLE("")
-    NS_RETURNS_RETAINED;
+- (nullable NSArray<ExecuTorchValue *> *)
+    forwardWithInputs:(NSArray<ExecuTorchValue *> *)values
+                error:(NSError **)error
+    NS_SWIFT_UNAVAILABLE("")NS_RETURNS_RETAINED;
 
 /**
  * Executes the "forward" method with the provided single input value.
  *
- * This is a convenience method that calls the executeMethod with "forward" as the method name.
+ * This is a convenience method that calls the executeMethod with "forward" as
+ * the method name.
  *
  * @param value An ExecuTorchValue object representing the input.
  * @param error A pointer to an NSError pointer that is set if an error occurs.
- * @return An NSArray of ExecuTorchValue objects representing the outputs, or nil in case of an error.
+ * @return An NSArray of ExecuTorchValue objects representing the outputs, or
+ * nil in case of an error.
  */
-- (nullable NSArray<ExecuTorchValue *> *)forwardWithInput:(ExecuTorchValue *)value
+- (nullable NSArray<ExecuTorchValue *> *)forwardWithInput:
+                                             (ExecuTorchValue *)value
                                                     error:(NSError **)error
-    NS_SWIFT_UNAVAILABLE("")
-    NS_RETURNS_RETAINED;
+    NS_SWIFT_UNAVAILABLE("")NS_RETURNS_RETAINED;
 
 /**
  * Executes the "forward" method with no inputs.
  *
- * This is a convenience method that calls the executeMethod with "forward" as the method name.
+ * This is a convenience method that calls the executeMethod with "forward" as
+ * the method name.
  *
  * @param error A pointer to an NSError pointer that is set if an error occurs.
- * @return An NSArray of ExecuTorchValue objects representing the outputs, or nil in case of an error.
+ * @return An NSArray of ExecuTorchValue objects representing the outputs, or
+ * nil in case of an error.
  */
 - (nullable NSArray<ExecuTorchValue *> *)forward:(NSError **)error
     NS_RETURNS_RETAINED;
 
 /**
  * Executes the "forward" method with the provided input tensors.
  *
- * This is a convenience method that calls the executeMethod with "forward" as the method name.
+ * This is a convenience method that calls the executeMethod with "forward" as
+ * the method name.
  *
- * @param tensors An NSArray of ExecuTorchTensor objects representing the inputs.
+ * @param tensors An NSArray of ExecuTorchTensor objects representing the
+ * inputs.
  * @param error A pointer to an NSError pointer that is set if an error occurs.
- * @return An NSArray of ExecuTorchValue objects representing the outputs, or nil in case of an error.
+ * @return An NSArray of ExecuTorchValue objects representing the outputs, or
+ * nil in case of an error.
  */
-- (nullable NSArray<ExecuTorchValue *> *)forwardWithTensors:(NSArray<ExecuTorchTensor *> *)tensors
-                                                      error:(NSError **)error
-    NS_SWIFT_UNAVAILABLE("")
-    NS_RETURNS_RETAINED;
+- (nullable NSArray<ExecuTorchValue *> *)
+    forwardWithTensors:(NSArray<ExecuTorchTensor *> *)tensors
+                 error:(NSError **)error
+    NS_SWIFT_UNAVAILABLE("")NS_RETURNS_RETAINED;
 
 /**
  * Executes the "forward" method with the provided single input tensor.
  *
- * This is a convenience method that calls the executeMethod with "forward" as the method name.
+ * This is a convenience method that calls the executeMethod with "forward" as
+ * the method name.
  *
  * @param tensor An ExecuTorchTensor object representing the input.
  * @param error A pointer to an NSError pointer that is set if an error occurs.
- * @return An NSArray of ExecuTorchValue objects representing the outputs, or nil in case of an error.
+ * @return An NSArray of ExecuTorchValue objects representing the outputs, or
+ * nil in case of an error.
  */
-- (nullable NSArray<ExecuTorchValue *> *)forwardWithTensor:(ExecuTorchTensor *)tensor
+- (nullable NSArray<ExecuTorchValue *> *)forwardWithTensor:
+                                             (ExecuTorchTensor *)tensor
                                                      error:(NSError **)error
-    NS_SWIFT_UNAVAILABLE("")
-    NS_RETURNS_RETAINED;
+    NS_SWIFT_UNAVAILABLE("")NS_RETURNS_RETAINED;
 
 /**
  * Sets a single input value for the "forward" method at index 0.