Update api reference docs

Author: benITo47

packages/react-native-executorch/common/rnexecutorch/models/instance_segmentation/Types.h

@@ -4,17 +4,23 @@
 
 namespace rnexecutorch::models::instance_segmentation::types {
 
+/**
+ * Represents a single detected instance in instance segmentation output.
+ *
+ * Contains bounding box coordinates, binary segmentation mask, class label,
+ * confidence score, and a unique instance identifier.
+ */
 struct InstanceMask {
-  float x1;
-  float y1;
-  float x2;
-  float y2;
-  std::vector<uint8_t> mask;
-  int maskWidth;
-  int maskHeight;
-  int label;
-  float score;
-  int instanceId;
+  float x1;                  ///< Bounding box left coordinate
+  float y1;                  ///< Bounding box top coordinate
+  float x2;                  ///< Bounding box right coordinate
+  float y2;                  ///< Bounding box bottom coordinate
+  std::vector<uint8_t> mask; ///< Binary mask (0 or 1) for the instance
+  int maskWidth;             ///< Width of the mask array
+  int maskHeight;            ///< Height of the mask array
+  int label;                 ///< Class label index
+  float score;               ///< Confidence score [0, 1]
+  int instanceId;            ///< Unique identifier for this instance
 };
 
 } // namespace rnexecutorch::models::instance_segmentation::types

packages/react-native-executorch/src/hooks/computer_vision/useInstanceSegmentation.ts

@@ -16,14 +16,27 @@ import { RnExecutorchError, parseUnknownError } from '../../errors/errorUtils';
 /**
  * React hook for managing an Instance Segmentation model instance.
  *
- * @typeParam C - A {@link InstanceSegmentationModelSources} config specifying which built-in model to load.
+ * @typeParam C - A {@link InstanceSegmentationModelSources} config specifying which model to load.
  * @param props - Configuration object containing `model` config and optional `preventLoad` flag.
  * @returns An object with model state (`error`, `isReady`, `isGenerating`, `downloadProgress`) and a typed `forward` function.
  *
  * @example
  * ```ts
- * const { isReady, forward } = useInstanceSegmentation({
- *   model: { modelName: 'yolo26n-seg', modelSource: YOLO26N_SEG },
+ * const { isReady, isGenerating, forward, error, downloadProgress } =
+ *   useInstanceSegmentation({
+ *     model: {
+ *       modelName: 'yolo26n-seg',
+ *       modelSource: 'https://huggingface.co/.../yolo26n-seg.pte',
+ *     },
+ *   });
+ *
+ * if (!isReady) {
+ *   return <Text>Loading: {(downloadProgress * 100).toFixed(0)}%</Text>;
+ * }
+ *
+ * const results = await forward('path/to/image.jpg', {
+ *   confidenceThreshold: 0.5,
+ *   inputSize: 640,
  * });
  * ```
  *

packages/react-native-executorch/src/modules/computer_vision/InstanceSegmentationModule.ts

@@ -60,12 +60,31 @@ type ResolveLabels<T extends InstanceSegmentationModelName | LabelEnum> =
 
 /**
  * Generic instance segmentation module with type-safe label maps.
- * Use a model name (e.g. `'yolo26n-seg'`) as the generic parameter for built-in models,
+ * Use a model name (e.g. `'yolo26n-seg'`) as the generic parameter for pre-configured models,
  * or a custom label enum for custom configs.
  *
- * @typeParam T - Either a built-in model name or a custom {@link LabelEnum} label map.
+ * Supported models (download from HuggingFace):
+ * - `yolo26n-seg`, `yolo26s-seg`, `yolo26m-seg`, `yolo26l-seg`, `yolo26x-seg` - YOLO models with COCO labels (80 classes)
+ *
+ * @typeParam T - Either a pre-configured model name from {@link InstanceSegmentationModelName}
+ *   or a custom {@link LabelEnum} label map.
  *
  * @category Typescript API
+ *
+ * @example
+ * ```ts
+ * const segmentation = await InstanceSegmentationModule.fromModelName({
+ *   modelName: 'yolo26n-seg',
+ *   modelSource: 'https://huggingface.co/.../yolo26n-seg.pte',
+ * });
+ *
+ * const results = await segmentation.forward('path/to/image.jpg', {
+ *   confidenceThreshold: 0.5,
+ *   iouThreshold: 0.45,
+ *   maxInstances: 20,
+ *   inputSize: 640,
+ * });
+ * ```
  */
 export class InstanceSegmentationModule<
   T extends InstanceSegmentationModelName | LabelEnum,
@@ -88,7 +107,7 @@ export class InstanceSegmentationModule<
   override async load() {}
 
   /**
-   * Creates an instance segmentation module for a built-in model.
+   * Creates an instance segmentation module for a pre-configured model.
    * The config object is discriminated by `modelName` — each model can require different fields.
    *
    * @param config - A {@link InstanceSegmentationModelSources} object specifying which model to load and where to fetch it from.
@@ -99,7 +118,7 @@ export class InstanceSegmentationModule<
    * ```ts
    * const segmentation = await InstanceSegmentationModule.fromModelName({
    *   modelName: 'yolo26n-seg',
-   *   modelSource: 'https://example.com/yolo26n-seg.pte',
+   *   modelSource: 'https://huggingface.co/.../yolo26n-seg.pte',
    * });
    * ```
    */
@@ -145,19 +164,29 @@ export class InstanceSegmentationModule<
 
   /**
    * Creates an instance segmentation module with a user-provided label map and custom config.
-   * Use this when working with a custom-exported segmentation model that is not one of the built-in models.
+   * Use this when working with a custom-exported segmentation model that is not one of the pre-configured models.
    *
    * @param modelSource - A fetchable resource pointing to the model binary.
-   * @param config - A {@link InstanceSegmentationConfig} object with the label map.
+   * @param config - A {@link InstanceSegmentationConfig} object with the label map and optional preprocessing parameters.
    * @param onDownloadProgress - Optional callback to monitor download progress, receiving a value between 0 and 1.
    * @returns A Promise resolving to an `InstanceSegmentationModule` instance typed to the provided label map.
    *
    * @example
    * ```ts
    * const MyLabels = { PERSON: 0, CAR: 1 } as const;
    * const segmentation = await InstanceSegmentationModule.fromCustomConfig(
-   *   'https://example.com/custom_model.pte',
-   *   { labelMap: MyLabels },
+   *   'https://huggingface.co/.../custom_model.pte',
+   *   {
+   *     labelMap: MyLabels,
+   *     availableInputSizes: [640],
+   *     defaultInputSize: 640,
+   *     postprocessorConfig: {
+   *       type: 'yolo',
+   *       defaultConfidenceThreshold: 0.5,
+   *       defaultIouThreshold: 0.45,
+   *       applyNMS: true,
+   *     },
+   *   },
    * );
    * ```
    */
@@ -201,9 +230,25 @@ export class InstanceSegmentationModule<
    * Executes the model's forward pass to perform instance segmentation on the provided image.
    *
    * @param imageSource - A string representing the image source (e.g., a file path, URI, or Base64-encoded string).
-   * @param options - Optional configuration for the segmentation process.
-   * @returns A Promise resolving to an array of instance masks.
-   * @throws {RnExecutorchError} If the model is not loaded.
+   * @param options - Optional configuration for the segmentation process. Includes `confidenceThreshold`, `iouThreshold`, `maxInstances`, `classesOfInterest`, `returnMaskAtOriginalResolution`, and `inputSize`.
+   * @returns A Promise resolving to an array of {@link SegmentedInstance} objects with `bbox`, `mask`, `maskWidth`, `maskHeight`, `label`, `score`, and `instanceId`.
+   * @throws {RnExecutorchError} If the model is not loaded or if an invalid `inputSize` is provided.
+   *
+   * @example
+   * ```ts
+   * const results = await segmentation.forward('path/to/image.jpg', {
+   *   confidenceThreshold: 0.6,
+   *   iouThreshold: 0.5,
+   *   maxInstances: 10,
+   *   inputSize: 640,
+   *   classesOfInterest: ['PERSON', 'CAR'],
+   *   returnMaskAtOriginalResolution: true,
+   * });
+   *
+   * results.forEach((inst) => {
+   *   console.log(`${inst.label}: ${(inst.score * 100).toFixed(1)}%`);
+   * });
+   * ```
    */
   async forward(
     imageSource: string,

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

@@ -152,6 +152,14 @@ export type InstanceSegmentationModelName =
 export type ModelNameOf<C extends InstanceSegmentationModelSources> =
   C['modelName'];
 
+/**
+ * Alias for {@link ModelNameOf}. Extracts the instance segmentation model name from a config object.
+ *
+ * @category Types
+ */
+export type InstanceModelNameOf<C extends InstanceSegmentationModelSources> =
+  ModelNameOf<C>;
+
 /**
  * Props for the `useInstanceSegmentation` hook.
  *