react-native-executorch 0.5.6 → 0.5.8

package/third-party/include/executorch/ExecuTorchModule.h

@@ -10,6 +10,91 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
+/**
+ * Holds the static metadata for a single tensor: its shape, layout,
+ * element type, whether its memory was pre-planned by the runtime,
+ * and its debug name.
+ */
+NS_SWIFT_NAME(TensorMetadata)
+__attribute__((deprecated("This API is experimental.")))
+@interface ExecuTorchTensorMetadata : NSObject
+
+/** The size of each dimension. */
+@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;
+
+/** The scalar type of each element in the tensor. */
+@property(nonatomic, readonly) ExecuTorchDataType dataType;
+
+/** YES if the runtime pre-allocated memory for this tensor. */
+@property(nonatomic, readonly) BOOL isMemoryPlanned;
+
+/** The (optional) user-visible name of this tensor (may be empty) */
+@property(nonatomic, readonly) NSString *name;
+
++ (instancetype)new NS_UNAVAILABLE;
+- (instancetype)init NS_UNAVAILABLE;
+
+@end
+
+/**
+ * Encapsulates all of the metadata for a loaded method: its name,
+ * how many inputs/outputs/attributes it has, per-argument tags,
+ * per-tensor metadata, buffer sizes, backends, and instruction count.
+ */
+NS_SWIFT_NAME(MethodMetadata)
+__attribute__((deprecated("This API is experimental.")))
+@interface ExecuTorchMethodMetadata : NSObject
+
+/** The method’s 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;
+
+/** An array of ExecuTorchValueTag raw values, one per declared output. */
+@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;
+
+/**
+ * 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;
+
+/** A list of attribute TensorsMetadata. */
+@property(nonatomic, readonly)
+    NSArray<ExecuTorchTensorMetadata *> *attributeTensorMetadata;
+
+/** A list of memory-planned buffer sizes. */
+@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;
+
+/** Total number of low-level instructions in this method’s body. */
+@property(nonatomic, readonly) NSInteger instructionCount;
+
++ (instancetype)new NS_UNAVAILABLE;
+- (instancetype)init NS_UNAVAILABLE;
+
+@end
+
 /**
  * Enum to define loading behavior.
  * Values can be a subset, but must numerically match exactly those defined in
@@ -121,7 +206,23 @@ __attribute__((deprecated("This API is experimental.")))
  * @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.
  */
-- (nullable NSSet<NSString *> *)methodNames:(NSError **)error;
+- (nullable NSSet<NSString *> *)methodNames:(NSError **)error
+    NS_RETURNS_RETAINED;
+
+/**
+ * Retrieves full metadata for a particular method in the loaded module.
+ *
+ * This includes the method’s name, input/output value tags, tensor shapes
+ * and layouts, buffer sizes, backend support list, and instruction count.
+ *
+ * @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.
+ */
+- (nullable ExecuTorchMethodMetadata *)methodMetadata:(NSString *)methodName
+                                                error:(NSError **)error
+    NS_RETURNS_RETAINED;
 
 /**
  * Executes a specific method with the provided input values.
@@ -137,7 +238,7 @@ __attribute__((deprecated("This API is experimental.")))
 - (nullable NSArray<ExecuTorchValue *> *)
     executeMethod:(NSString *)methodName
        withInputs:(NSArray<ExecuTorchValue *> *)values
-            error:(NSError **)error NS_SWIFT_NAME(execute(_:_:));
+            error:(NSError **)error NS_REFINED_FOR_SWIFT NS_RETURNS_RETAINED;
 
 /**
  * Executes a specific method with the provided single input value.
@@ -153,7 +254,7 @@ __attribute__((deprecated("This API is experimental.")))
 - (nullable NSArray<ExecuTorchValue *> *)executeMethod:(NSString *)methodName
                                              withInput:(ExecuTorchValue *)value
                                                  error:(NSError **)error
-    NS_SWIFT_NAME(execute(_:_:));
+    NS_SWIFT_UNAVAILABLE("")NS_RETURNS_RETAINED;
 
 /**
  * Executes a specific method with no input values.
@@ -167,7 +268,7 @@ __attribute__((deprecated("This API is experimental.")))
  */
 - (nullable NSArray<ExecuTorchValue *> *)executeMethod:(NSString *)methodName
                                                  error:(NSError **)error
-    NS_SWIFT_NAME(execute(_:));
+    NS_SWIFT_NAME(execute(_:)) NS_RETURNS_RETAINED;
 
 /**
  * Executes a specific method with the provided input tensors.
@@ -184,7 +285,7 @@ __attribute__((deprecated("This API is experimental.")))
 - (nullable NSArray<ExecuTorchValue *> *)
     executeMethod:(NSString *)methodName
       withTensors:(NSArray<ExecuTorchTensor *> *)tensors
-            error:(NSError **)error NS_SWIFT_NAME(execute(_:_:));
+            error:(NSError **)error NS_SWIFT_UNAVAILABLE("")NS_RETURNS_RETAINED;
 
 /**
  * Executes a specific method with the provided single input tensor.
@@ -201,7 +302,7 @@ __attribute__((deprecated("This API is experimental.")))
                                             withTensor:
                                                 (ExecuTorchTensor *)tensor
                                                  error:(NSError **)error
-    NS_SWIFT_NAME(execute(_:_:));
+    NS_SWIFT_UNAVAILABLE("")NS_RETURNS_RETAINED;
 
 /**
  * Executes the "forward" method with the provided input values.
@@ -216,7 +317,8 @@ __attribute__((deprecated("This API is experimental.")))
  */
 - (nullable NSArray<ExecuTorchValue *> *)
     forwardWithInputs:(NSArray<ExecuTorchValue *> *)values
-                error:(NSError **)error NS_SWIFT_NAME(forward(_:));
+                error:(NSError **)error
+    NS_SWIFT_UNAVAILABLE("")NS_RETURNS_RETAINED;
 
 /**
  * Executes the "forward" method with the provided single input value.
@@ -232,7 +334,7 @@ __attribute__((deprecated("This API is experimental.")))
 - (nullable NSArray<ExecuTorchValue *> *)forwardWithInput:
                                              (ExecuTorchValue *)value
                                                     error:(NSError **)error
-    NS_SWIFT_NAME(forward(_:));
+    NS_SWIFT_UNAVAILABLE("")NS_RETURNS_RETAINED;
 
 /**
  * Executes the "forward" method with no inputs.
@@ -244,7 +346,8 @@ __attribute__((deprecated("This API is experimental.")))
  * @return An NSArray of ExecuTorchValue objects representing the outputs, or
  * nil in case of an error.
  */
-- (nullable NSArray<ExecuTorchValue *> *)forward:(NSError **)error;
+- (nullable NSArray<ExecuTorchValue *> *)forward:(NSError **)error
+    NS_RETURNS_RETAINED;
 
 /**
  * Executes the "forward" method with the provided input tensors.
@@ -260,7 +363,8 @@ __attribute__((deprecated("This API is experimental.")))
  */
 - (nullable NSArray<ExecuTorchValue *> *)
     forwardWithTensors:(NSArray<ExecuTorchTensor *> *)tensors
-                 error:(NSError **)error NS_SWIFT_NAME(forward(_:));
+                 error:(NSError **)error
+    NS_SWIFT_UNAVAILABLE("")NS_RETURNS_RETAINED;
 
 /**
  * Executes the "forward" method with the provided single input tensor.
@@ -276,7 +380,7 @@ __attribute__((deprecated("This API is experimental.")))
 - (nullable NSArray<ExecuTorchValue *> *)forwardWithTensor:
                                              (ExecuTorchTensor *)tensor
                                                      error:(NSError **)error
-    NS_SWIFT_NAME(forward(_:));
+    NS_SWIFT_UNAVAILABLE("")NS_RETURNS_RETAINED;
 
 + (instancetype)new NS_UNAVAILABLE;
 - (instancetype)init NS_UNAVAILABLE;