Enhance VAD and part of TTS documentation

Author: msluszniak

packages/react-native-executorch/src/hooks/natural_language_processing/useTextEmbeddings.ts

@@ -1,14 +1,14 @@
 import { TextEmbeddingsModule } from '../../modules/natural_language_processing/TextEmbeddingsModule';
 import { useModule } from '../useModule';
-import { TextEmbeddingsType, Props } from '../../types/textEmbeddings';
+import { TextEmbeddingsType, TextEmbeddingsProps } from '../../types/textEmbeddings';
 
 /**
  * React hook for managing a Text Embeddings model instance.
  * 
  * @param TextEmbeddingsConfiguration - Configuration object containing `model` source and optional `preventLoad` flag.
  * @returns Ready to use Text Embeddings model.
  */
-export const useTextEmbeddings = ({ model, preventLoad = false }: Props): TextEmbeddingsType =>
+export const useTextEmbeddings = ({ model, preventLoad = false }: TextEmbeddingsProps): TextEmbeddingsType =>
   useModule({
     module: TextEmbeddingsModule,
     model,

packages/react-native-executorch/src/hooks/natural_language_processing/useTextToSpeech.ts

@@ -12,6 +12,13 @@ interface Props extends TextToSpeechConfig {
   preventLoad?: boolean;
 }
 
+
+/**
+ * React hook for managing Text to Speech instance.
+ * 
+ * @param TextToSpeechConfiguration - Configuration object containing `model` source, `voice` and optional `preventLoad`.
+ * @returns Ready to use Text to Speech model.
+ */
 export const useTextToSpeech = ({
   model,
   voice,

packages/react-native-executorch/src/hooks/natural_language_processing/useTokenizer.ts

@@ -6,6 +6,7 @@ import { RnExecutorchError, parseUnknownError } from '../../errors/errorUtils';
 import { TokenizerType } from '../../types/tokenizer';  
 
 /**
+ * React hook for managing a Tokenizer instance.
  * 
  * @param tokenizerConfiguration - Configuration object containing `tokenizer` source and optional `preventLoad` flag. 
  * @returns Ready to use Tokenizer model.

packages/react-native-executorch/src/hooks/natural_language_processing/useVAD.ts

@@ -1,13 +1,14 @@
-import { ResourceSource } from '../../types/common';
 import { useModule } from '../useModule';
 import { VADModule } from '../../modules/natural_language_processing/VADModule';
+import { VADType, VADProps } from '../../types/vad';
 
-interface Props {
-  model: { modelSource: ResourceSource };
-  preventLoad?: boolean;
-}
-
-export const useVAD = ({ model, preventLoad = false }: Props) =>
+/**
+ * React hook for managing a VAD model instance.
+ * 
+ * @param VADConfiguration - Configuration object containing `model` source and optional `preventLoad` flag. 
+ * @returns Ready to use VAD model.
+ */
+export const useVAD = ({ model, preventLoad = false }: VADProps): VADType =>
   useModule({
     module: VADModule,
     model,

packages/react-native-executorch/src/hooks/useModule.ts

@@ -93,13 +93,6 @@ export const useModule = <
      * Represents the download progress as a value between 0 and 1, indicating the extent of the model file retrieval.
      */
     downloadProgress,
-
-    /**
-     * This function runs the model's forward method with the provided input arguments.
-     *
-     * @param input - Input arguments for the model's forward method.
-     * @returns The output from the model's forward method.
-     */
     forward,
   };
 };

packages/react-native-executorch/src/types/textEmbeddings.ts

@@ -36,7 +36,7 @@ export interface TextEmbeddingsType {
 /**
  * Props for the useTextEmbeddings hook.
  */
-export interface Props {
+export interface TextEmbeddingsProps {
   model: {
     /**
      * `ResourceSource` that specifies the location of the model binary.

packages/react-native-executorch/src/types/vad.ts

@@ -1,4 +1,64 @@
+import { ResourceSource } from '../types/common';
+import { RnExecutorchError } from '../errors/errorUtils';
+
+/**
+ * Props for the useVAD hook.
+ */
+export interface VADProps {
+  /**
+   * `ResourceSource` that specifies the location of the VAD model binary.
+   */
+  model: { modelSource: ResourceSource };
+
+  /**
+   * Boolean that can prevent automatic model loading (and downloading the data if you load it for the first time) after running the hook.
+   */
+  preventLoad?: boolean;
+}
+
+/**
+ * Represents a detected audio segment with start and end timestamps.
+ */
 export interface Segment {
+  /**
+   * Start time of the segment in seconds.
+   */
   start: number;
+
+  /**
+   * End time of the segment in seconds.
+   */
   end: number;
 }
+
+/**
+ * React hook state and methods for managing a Voice Activity Detection (VAD) model instance.
+ */
+export interface VADType {
+  /**
+   * Contains the error message if the VAD model failed to load or during processing.
+   */
+  error: null | RnExecutorchError;
+
+  /**
+   * Indicates whether the VAD model has successfully loaded and is ready for inference.
+   */
+  isReady: boolean;
+
+  /**
+   * Indicates whether the model is currently processing an inference.
+   */
+  isGenerating: boolean;
+
+  /**
+   * Represents the download progress as a value between 0 and 1.
+   */
+  downloadProgress: number;
+
+  /**
+   * Runs the Voice Activity Detection model on the provided audio waveform.
+   * @param waveform - The input audio waveform array.
+   * @returns A promise resolving to an array of detected audio segments (e.g., timestamps for speech).
+   */
+  forward(waveform: Float32Array): Promise<Segment[]>;
+}