docs: use {@link} type references instead of inline value lists in JSDoc

Replace inline enumerations (e.g., `stretch`, `letterbox`, `crop`)
with {@link} references to the named types. Expand 'IoU' to
'Intersection over Union (IoU)' for consistency.

Author: barhanc

packages/react-native-executorch/src/extensions/cv/ops/boxes.ts

@@ -75,8 +75,8 @@ export function decodeBox<F extends BoxFormat>(
  * @param opts Options defining dimensions and resize modes.
  * @param opts.from The source bounds (e.g. model input dimensions).
  * @param opts.to The destination bounds (e.g. original image dimensions).
- * @param opts.resizeMode The mode used to resize the image ('letterbox' or
- * 'stretch').
+ * @param opts.resizeMode The mode used to resize the image {@link ResizeMode}
+ * (excluding `'crop'`).
  * @returns The scaled BoundingBox object.
  */
 export function scaleBox<F extends BoxFormat>(
@@ -145,9 +145,9 @@ export function scaleBox<F extends BoxFormat>(
  * @category Types
  */
 export type NmsOptions = {
-  /** Bounding box format (`xyxy`, `cxcywh`, etc.). */
+  /** Bounding box format {@link BoxFormat}. */
   readonly boxFormat: BoxFormat;
-  /** IoU threshold for suppressing overlapping boxes. */
+  /** Intersection over Union (IoU) threshold for suppressing overlapping boxes. */
   readonly iouThreshold: number;
   /** Minimum confidence score threshold for filtering candidate boxes. */
   readonly confidenceThreshold: number;
@@ -165,12 +165,12 @@ export type NmsOptions = {
  * @param boxes Bounding boxes coordinate tensor.
  * @param scores Bounding boxes confidence scores tensor.
  * @param opts Options configuring NMS thresholds and execution mode.
- * @param opts.boxFormat Bounding box format (`xyxy`, `cxcywh`, etc.).
+ * @param opts.boxFormat The bounding box format {@link BoxFormat}.
  * @param opts.iouThreshold Intersection over Union (IoU) threshold for
  * suppression.
  * @param opts.confidenceThreshold Minimum confidence score for candidate
  * selection.
- * @param opts.nmsType Suppression algorithm mode (`standard` or `weighted`).
+ * @param opts.nmsType The NMS algorithm variant {@link NmsOptions.nmsType}.
  * @returns The resulting indices of the non-suppressed boxes:
  * - For `standard` NMS: A 1D array of indices (`number[]`) representing the
  *   selected boxes.

packages/react-native-executorch/src/extensions/cv/ops/image.ts

@@ -74,11 +74,11 @@ export type InterpolationMethod = 'nearest' | 'area' | 'cubic' | 'lanczos' | 'li
  * @category Types
  */
 export type ResizeOptions = {
-  /** Resize algorithm mode (`stretch`, `letterbox`, `crop`). */
+  /** Resize algorithm mode {@link ResizeMode}. */
   readonly mode?: ResizeMode;
   /** Background fill value used when letterboxing. */
   readonly padValue?: number;
-  /** Pixel interpolation method. */
+  /** Pixel interpolation method {@link InterpolationMethod}. */
   readonly interpolation?: InterpolationMethod;
 };
 
@@ -96,18 +96,17 @@ export type NormalizeOptions = {
 /**
  * Resizes an image tensor from a source dimension to a destination dimension.
  *
- * Supports various resize modes (`stretch`, `letterbox`, `crop`) and
- * interpolation algorithms (`linear`, `lanczos`, etc.).
+ * Supports various {@link ResizeMode} and {@link InterpolationMethod} options.
  * @category Typescript API
  * @param src The source image tensor in HWC layout. Shape [H,W,C].
  * @param dst The pre-allocated destination tensor to write the resized image
  * to. `dst` must be in HWC layout and its number of channels must match `src`.
  * Shape [H',W',C].
  * @param opts Configuration options for resizing.
- * @param opts.mode Resize algorithm mode (`stretch`, `letterbox`, `crop`).
- * Defaults to `'stretch'`.
- * @param opts.interpolation Pixel interpolation method (`linear`, `lanczos`,
- * etc.). Defaults to `'lanczos'`.
+ * @param opts.mode The resize algorithm mode {@link ResizeMode}. Defaults to
+ * `'stretch'`.
+ * @param opts.interpolation The pixel interpolation method
+ * {@link InterpolationMethod}. Defaults to `'lanczos'`.
  * @param opts.padValue Fill value for letterboxing. Defaults to `0`.
  * @returns The destination tensor containing the resized image.
  */

packages/react-native-executorch/src/extensions/cv/ops/points.ts

@@ -17,8 +17,8 @@ export type Point = {
  * @param opts Options detailing the scaling factors and resize mode.
  * @param opts.from The source bounds (e.g. model input dimensions).
  * @param opts.to The destination bounds (e.g. original image dimensions).
- * @param opts.resizeMode The mode used to resize the image ('letterbox' or
- * 'stretch').
+ * @param opts.resizeMode The mode used to resize the image {@link ResizeMode}
+ * (excluding `'crop'`).
  * @returns The scaled coordinate point.
  */
 export function scalePoint(

packages/react-native-executorch/src/extensions/cv/tasks/instanceSegmentation.ts

@@ -31,13 +31,13 @@ export type InstanceSegmenterOptions<F extends BoxFormat, L> = Omit<
   ImagePreprocessorOptions,
   'resizeMode'
 > & {
-  /** Resize mode for input images. */
+  /** Resize mode for input images. Must be `'stretch'`. */
   readonly resizeMode: 'stretch';
   /** Array of class labels matching the model's output vocabulary. */
   readonly labels: readonly L[];
-  /** Bounding box format exported by the model (`xyxy`, `cxcywh`, etc.). */
+  /** Bounding box format {@link BoxFormat}. */
   readonly boxFormat: F;
-  /** Default IoU threshold for Non-Maximum Suppression (NMS). */
+  /** Default Intersection over Union (IoU) threshold for Non-Maximum Suppression (NMS). */
   readonly defaultIouThreshold: number;
   /** Default probability threshold for mask values. */
   readonly defaultMaskThreshold: number;
@@ -107,7 +107,7 @@ export async function createInstanceSegmenter<F extends BoxFormat, L>(
    * @param options Execution override options.
    * @param options.confidenceThreshold Minimum confidence threshold. If
    * omitted, uses `modelOpts.defaultConfidenceThreshold`.
-   * @param options.iouThreshold IoU threshold in NMS. If omitted, uses
+   * @param options.iouThreshold Intersection over Union (IoU) threshold in NMS. If omitted, uses
    * `modelOpts.defaultIouThreshold`.
    * @param options.maskThreshold Mask binarization threshold. If omitted,
    * uses `modelOpts.defaultMaskThreshold`.

packages/react-native-executorch/src/extensions/cv/tasks/keypointDetection.ts

@@ -22,13 +22,13 @@ export type KeypointDetectorOptions<F extends BoxFormat, L extends PropertyKey>
   ImagePreprocessorOptions,
   'resizeMode'
 > & {
-  /** Resize mode for preprocessing input images (`stretch` or `letterbox`). */
+  /** Resize mode for preprocessing input images {@link ResizeMode} (excluding `'crop'`). */
   readonly resizeMode: Exclude<ResizeMode, 'crop'>;
-  /** Bounding box format exported by the model (`xyxy`, `cxcywh`, etc.). */
+  /** Bounding box format {@link BoxFormat}. */
   readonly boxFormat: F;
   /** Array of landmark names matching the model output keypoint locations. */
   readonly landmarks: readonly L[];
-  /** Default IoU threshold for Non-Maximum Suppression (NMS). */
+  /** Default Intersection over Union (IoU) threshold for Non-Maximum Suppression (NMS). */
   readonly defaultIouThreshold: number;
   /** Default minimum confidence score threshold for keypoint detections. */
   readonly defaultConfidenceThreshold: number;

packages/react-native-executorch/src/extensions/cv/tasks/objectDetection.ts

@@ -21,13 +21,13 @@ export type ObjectDetectorOptions<F extends BoxFormat, L> = Omit<
   ImagePreprocessorOptions,
   'resizeMode'
 > & {
-  /** Resize mode for preprocessing input images (`stretch` or `letterbox`). */
+  /** Resize mode for preprocessing input images {@link ResizeMode} (excluding `'crop'`). */
   readonly resizeMode: Exclude<ResizeMode, 'crop'>;
   /** Array of class labels matching the model's output vocabulary. */
   readonly labels: readonly L[];
-  /** Bounding box format exported by the model (`xyxy`, `cxcywh`, etc.). */
+  /** Bounding box format {@link BoxFormat}. */
   readonly boxFormat: F;
-  /** Default IoU threshold for Non-Maximum Suppression (NMS). */
+  /** Default Intersection over Union (IoU) threshold for Non-Maximum Suppression (NMS). */
   readonly defaultIouThreshold: number;
   /** Default minimum confidence score threshold for detections. */
   readonly defaultConfidenceThreshold: number;
@@ -86,7 +86,7 @@ export async function createObjectDetector<F extends BoxFormat, L>(
    * @param options Configuration options for object detection.
    * @param options.confidenceThreshold Minimum confidence score threshold. If
    * omitted, uses `modelOpts.defaultConfidenceThreshold`.
-   * @param options.iouThreshold Non-maximum suppression IoU threshold. If
+   * @param options.iouThreshold Intersection over Union (IoU) threshold. If
    * omitted, uses `modelOpts.defaultIouThreshold`.
    * @returns A promise resolving to the list of object detections.
    */

packages/react-native-executorch/src/extensions/cv/tasks/preprocessing.ts

@@ -19,9 +19,9 @@ import {
  * @category Types
  */
 export type ImagePreprocessorOptions = {
-  /** Resize algorithm mode (`stretch`, `letterbox`, `crop`). */
+  /** Resize algorithm mode {@link ResizeMode}. */
   readonly resizeMode: ResizeMode;
-  /** Pixel interpolation method (`linear`, `lanczos`, etc.). */
+  /** Pixel interpolation method {@link InterpolationMethod}. */
   readonly interpolation: InterpolationMethod;
   /** Normalization scaling coefficients. */
   readonly normalizeOpts: NormalizeOptions;

packages/react-native-executorch/src/extensions/cv/tasks/semanticSegmentation.ts

@@ -23,7 +23,7 @@ import { sigmoid, argmax } from '../../math';
  * @category Types
  */
 export type SemanticSegmenterOptions<L> = Omit<ImagePreprocessorOptions, 'resizeMode'> & {
-  /** Resize mode for input images. */
+  /** Resize mode for input images. Must be `'stretch'`. */
   readonly resizeMode: 'stretch';
   /** Interpolation method used when resizing output masks back to input image dimensions. */
   readonly outInterpolation: InterpolationMethod;

packages/react-native-executorch/src/extensions/speech/utils/vadUtils.ts

@@ -8,7 +8,7 @@ import { type Tensor } from '../../../core/tensor';
 export type ExtractFramesOptions = {
   /** Number of audio frames to extract and write into the destination tensor. */
   readonly numFrames: number;
-  /** Samples between consecutive frames. */
+  /** Number of samples between consecutive frames. */
   readonly hopLength: number;
   /** Pre-emphasis filter coefficient. */
   readonly preemphasis: number;