Skip to content

[RNE Rewrite] style(ts): standardize task naming, preprocessor options, and TSDoc conventions - #1340

Open
barhanc wants to merge 4 commits into
rne-rewritefrom
@bh/ts-style-fixes
Open

[RNE Rewrite] style(ts): standardize task naming, preprocessor options, and TSDoc conventions#1340
barhanc wants to merge 4 commits into
rne-rewritefrom
@bh/ts-style-fixes

Conversation

@barhanc

@barhanc barhanc commented Jul 30, 2026

Copy link
Copy Markdown
Member

Description

  • Naming Consistency: Standardized ClassifierModel.opts (renamed from classifierOpts) and SemanticSegmenterModel / SemanticSegmenterOptions (renamed from SemanticSegmentationModel).

  • Preprocessor Options: Replaced top-level alpha/beta fields with a required normalizeOpts: NormalizeOptions property across all task option interfaces and models.ts presets.

  • TSDoc Standardization: Converted top-level @property tags to inline member JSDoc comments (/** ... */) and added function-level @param options.field fallback notes.

  • Immutability: Enforced readonly property modifiers on task results (SemanticSegmentationResult, BoxMap).

Introduces a breaking change?

  • Yes
  • No

Type of change

  • Bug fix (change which fixes an issue)
  • New feature (change which adds functionality)
  • Documentation update (improves or adds clarity to existing documentation)
  • Other (chores, tests, code style improvements etc.)

Tested on

  • iOS
  • Android

Testing instructions

  • Run the CV example app and verify that preprocessor options change didn't break anything.

Screenshots

Related issues

Checklist

  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have updated the documentation accordingly
  • My changes generate no new warnings

Additional notes

@barhanc barhanc self-assigned this Jul 30, 2026
@barhanc barhanc added refactoring improvement PRs or issues focused on improvements in the current codebase labels Jul 30, 2026
@barhanc
barhanc requested a review from msluszniak July 31, 2026 09:55
* @param options.confidenceThreshold Minimum confidence score for returned
* detections.
* @param options.iouThreshold Non-maximum suppression IoU threshold.
* @param options.confidenceThreshold Minimum confidence score threshold. If

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

options and opts, I don't know if this won't cause a confusion.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

improvement PRs or issues focused on improvements in the current codebase refactoring

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants