Skip to content

Commit fec14ac

Browse files
committed
Change typedoc links
1 parent bd0fa30 commit fec14ac

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ const YOLO_SEG_CONFIG: InstanceSegmentationConfig<typeof CocoLabel> = {
1919
defaultConfidenceThreshold: 0.5,
2020
defaultIouThreshold: 0.5,
2121
postprocessorConfig: {
22-
applyNMS: true,
22+
applyNMS: false,
2323
},
2424
};
2525

@@ -50,7 +50,7 @@ const ModelConfigs = {
5050
type ModelConfigsType = typeof ModelConfigs;
5151

5252
/**
53-
* Resolves the {@link LabelEnum} for a given built-in model name.
53+
* Resolves the label map type for a given built-in model name.
5454
*
5555
* @typeParam M - A built-in model name from {@link InstanceSegmentationModelName}.
5656
*
@@ -77,7 +77,7 @@ type ResolveLabels<T extends InstanceSegmentationModelName | LabelEnum> =
7777
* - `yolo26n-seg`, `yolo26s-seg`, `yolo26m-seg`, `yolo26l-seg`, `yolo26x-seg` - YOLO models with COCO labels (80 classes)
7878
*
7979
* @typeParam T - Either a pre-configured model name from {@link InstanceSegmentationModelName}
80-
* or a custom {@link LabelEnum} label map.
80+
* or a custom label map conforming to {@link LabelEnum}.
8181
*
8282
* @category Typescript API
8383
*

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import { Bbox } from './objectDetection';
55
/**
66
* Represents a single detected instance in instance segmentation output.
77
*
8-
* @typeParam L - The {@link LabelEnum} type for the model.
8+
* @typeParam L - The label map type for the model, must conform to {@link LabelEnum}.
99
* @category Types
1010
* @property {Bbox} bbox - The bounding box of the instance.
1111
* @property {Uint8Array} mask - Binary mask (0 or 1) representing the instance.
@@ -28,7 +28,7 @@ export interface SegmentedInstance<L extends LabelEnum> {
2828
/**
2929
* Options for instance segmentation forward pass.
3030
*
31-
* @typeParam L - The {@link LabelEnum} type for the model.
31+
* @typeParam L - The label map type for the model, must conform to {@link LabelEnum}.
3232
* @category Types
3333
*/
3434
export interface InstanceSegmentationOptions<L extends LabelEnum> {
@@ -63,9 +63,9 @@ export interface InstanceSegmentationOptions<L extends LabelEnum> {
6363
}
6464

6565
/**
66-
* Configuration for a custom instance segmentation model.
66+
* Configuration for an instance segmentation model.
6767
*
68-
* @typeParam T - The {@link LabelEnum} type for the model.
68+
* @typeParam T - The label map type for the model, must conform to {@link LabelEnum}.
6969
* @category Types
7070
*/
7171
export type InstanceSegmentationConfig<T extends LabelEnum> = {
@@ -137,7 +137,7 @@ export interface InstanceSegmentationProps<
137137
* Return type for the `useInstanceSegmentation` hook.
138138
* Manages the state and operations for instance segmentation models.
139139
*
140-
* @typeParam L - The {@link LabelEnum} representing the model's class labels.
140+
* @typeParam L - The label map type for the model, must conform to {@link LabelEnum}.
141141
*
142142
* @category Types
143143
*/
@@ -166,7 +166,7 @@ export interface InstanceSegmentationType<L extends LabelEnum> {
166166
* Executes the model's forward pass to perform instance segmentation on the provided image.
167167
* @param imageSource - A string representing the image source (e.g., a file path, URI, or base64 string) to be processed.
168168
* @param options - Optional configuration for the segmentation process.
169-
* @returns A Promise resolving to an array of instance masks.
169+
* @returns A Promise resolving to an array of {@link SegmentedInstance} objects.
170170
* @throws {RnExecutorchError} If the model is not loaded or is currently processing another image.
171171
*/
172172
forward: (

0 commit comments

Comments
 (0)