Add autogenerated API for React Native ExecuTorch documentation

docs/docs/06-api-reference/classes/ClassificationModule.md

@@ -0,0 +1,177 @@
+# Class: ClassificationModule
+
+Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ClassificationModule.ts:10](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts#L10)
+
+Module for image classification tasks.
+
+## Extends
+
+- `BaseModule`
+
+## Constructors
+
+### Constructor
+
+> **new ClassificationModule**(): `ClassificationModule`
+
+#### Returns
+
+`ClassificationModule`
+
+#### Inherited from
+
+`BaseModule.constructor`
+
+## Properties
+
+### nativeModule
+
+> **nativeModule**: `any` = `null`
+
+Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L8)
+
+Native module instance
+
+#### Inherited from
+
+`BaseModule.nativeModule`
+
+## Methods
+
+### delete()
+
+> **delete**(): `void`
+
+Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L41)
+
+Unloads the model from memory.
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+`BaseModule.delete`
+
+***
+
+### forward()
+
+> **forward**(`imageSource`): `Promise`\<\{\[`category`: `string`\]: `number`; \}\>
+
+Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ClassificationModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts#L41)
+
+Executes the model's forward pass, where `imageSource` can be a fetchable resource or a Base64-encoded string.
+
+#### Parameters
+
+##### imageSource
+
+`string`
+
+The image source to be classified.
+
+#### Returns
+
+`Promise`\<\{\[`category`: `string`\]: `number`; \}\>
+
+The classification result.
+
+***
+
+### forwardET()
+
+> `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\>
+
+Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L23)
+
+Runs the model's forward method with the given input tensors.
+It returns the output tensors that mimic the structure of output from ExecuTorch.
+
+#### Parameters
+
+##### inputTensor
+
+[`TensorPtr`](../interfaces/TensorPtr.md)[]
+
+Array of input tensors.
+
+#### Returns
+
+`Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\>
+
+Array of output tensors.
+
+#### Inherited from
+
+`BaseModule.forwardET`
+
+***
+
+### getInputShape()
+
+> **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\>
+
+Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L34)
+
+Gets the input shape for a given method and index.
+
+#### Parameters
+
+##### methodName
+
+`string`
+
+method name
+
+##### index
+
+`number`
+
+index of the argument which shape is requested
+
+#### Returns
+
+`Promise`\<`number`[]\>
+
+The input shape as an array of numbers.
+
+#### Inherited from
+
+`BaseModule.getInputShape`
+
+***
+
+### load()
+
+> **load**(`model`, `onDownloadProgressCallback`): `Promise`\<`void`\>
+
+Defined in: [packages/react-native-executorch/src/modules/computer\_vision/ClassificationModule.ts:18](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/computer_vision/ClassificationModule.ts#L18)
+
+Loads the model, where `modelSource` is a string that specifies the location of the model binary.
+To track the download progress, supply a callback function `onDownloadProgressCallback`.
+
+#### Parameters
+
+##### model
+
+Object containing `modelSource`.
+
+###### modelSource
+
+[`ResourceSource`](../type-aliases/ResourceSource.md)
+
+##### onDownloadProgressCallback
+
+(`progress`) => `void`
+
+Optional callback to monitor download progress.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Overrides
+
+`BaseModule.load`

docs/docs/06-api-reference/classes/ExecutorchModule.md

@@ -0,0 +1,174 @@
+# Class: ExecutorchModule
+
+Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts#L8)
+
+## Extends
+
+- `BaseModule`
+
+## Constructors
+
+### Constructor
+
+> **new ExecutorchModule**(): `ExecutorchModule`
+
+#### Returns
+
+`ExecutorchModule`
+
+#### Inherited from
+
+`BaseModule.constructor`
+
+## Properties
+
+### nativeModule
+
+> **nativeModule**: `any` = `null`
+
+Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:8](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L8)
+
+Native module instance
+
+#### Inherited from
+
+`BaseModule.nativeModule`
+
+## Methods
+
+### delete()
+
+> **delete**(): `void`
+
+Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:41](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L41)
+
+Unloads the model from memory.
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+`BaseModule.delete`
+
+***
+
+### forward()
+
+> **forward**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\>
+
+Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModule.ts:40](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts#L40)
+
+Executes the model's forward pass, where input is an array of `TensorPtr` objects. 
+If the inference is successful, an array of tensor pointers is returned.
+
+#### Parameters
+
+##### inputTensor
+
+[`TensorPtr`](../interfaces/TensorPtr.md)[]
+
+Array of input tensor pointers.
+
+#### Returns
+
+`Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\>
+
+An array of output tensor pointers.
+
+***
+
+### forwardET()
+
+> `protected` **forwardET**(`inputTensor`): `Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\>
+
+Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:23](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L23)
+
+Runs the model's forward method with the given input tensors.
+It returns the output tensors that mimic the structure of output from ExecuTorch.
+
+#### Parameters
+
+##### inputTensor
+
+[`TensorPtr`](../interfaces/TensorPtr.md)[]
+
+Array of input tensors.
+
+#### Returns
+
+`Promise`\<[`TensorPtr`](../interfaces/TensorPtr.md)[]\>
+
+Array of output tensors.
+
+#### Inherited from
+
+`BaseModule.forwardET`
+
+***
+
+### getInputShape()
+
+> **getInputShape**(`methodName`, `index`): `Promise`\<`number`[]\>
+
+Defined in: [packages/react-native-executorch/src/modules/BaseModule.ts:34](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/BaseModule.ts#L34)
+
+Gets the input shape for a given method and index.
+
+#### Parameters
+
+##### methodName
+
+`string`
+
+method name
+
+##### index
+
+`number`
+
+index of the argument which shape is requested
+
+#### Returns
+
+`Promise`\<`number`[]\>
+
+The input shape as an array of numbers.
+
+#### Inherited from
+
+`BaseModule.getInputShape`
+
+***
+
+### load()
+
+> **load**(`modelSource`, `onDownloadProgressCallback`): `Promise`\<`void`\>
+
+Defined in: [packages/react-native-executorch/src/modules/general/ExecutorchModule.ts:16](https://github.com/software-mansion/react-native-executorch/blob/a8b0a412aa07c92692caf0b31a2b58a5f754121c/packages/react-native-executorch/src/modules/general/ExecutorchModule.ts#L16)
+
+Loads the model, where `modelSource` is a string, number, or object that specifies the location of the model binary.
+Optionally accepts a download progress callback.
+
+#### Parameters
+
+##### modelSource
+
+[`ResourceSource`](../type-aliases/ResourceSource.md)
+
+Source of the model to be loaded.
+
+##### onDownloadProgressCallback
+
+(`progress`) => `void`
+
+Optional callback to monitor download progress.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Overrides
+
+`BaseModule.load`