[RNE Rewrite] chore!: miscellaneous jsdoc, export improvements and small fixes - #1376
[RNE Rewrite] chore!: miscellaneous jsdoc, export improvements and small fixes#1376barhanc wants to merge 35 commits into
Conversation
…types, and use undefined for absent state
…Prettier wrapping
…getRegisteredBackends as worklet
…ent tensor shapes/dtypes
- Add missing @category tags (schema.ts, telemetry.ts) - Add field-level JSDoc on LLM types (toolCalling, chatPreprocessor, tokenizerConfig) - Add @throws tags to LLM functions that throw (chatPreprocessor, tokenizerConfig, llmChatSession) - Add missing docs on schema.ts convenience functions (f32/i64/i32/ui8/bool, constr.eq/linear) - Standardize worklet one-liner pattern (semanticSegmentation, privacyFilter) - Improve hook @returns to reference create<Task> via @link (all 15 hooks) - Misc: add module docs (ops/index, fetcher/index), fix @link in vadUtils, remove @category from private postprocess
…ocument quad geometry
9c1dfb6 to
737071c
Compare
|
I'm wondering how do we want to communicate the fact that default model variant is probably rarely the optimal one? I think that our default behaviour will be including all backends etc. and if you want to exclude them, you need to do it manually. This way we would be able to set default models per platform which guarantees the best performance. Otherwise, I think that many people can miss huge advantage from backend acceleration. |
Agreed. This will require changes in the download scripts and opt-in logic, right? |
I need to double check before any changes in the model registry regarding changed defaulting behaviour. |
- Replace modelOpts references with linked option types in instanceSegmentation, objectDetection, and keypointDetection - Add links to boundingBoxOfPoints, TextEmbedder.embed, Tokenizer.decode, and download functions - Preserve original comments while adding proper documentation links
|
Four consistency gaps found while reviewing this branch. 1. Agent skills still document the old API. 2. Eight 3. 4. Two new typedoc warnings (three others are fixed by this PR): |
|
Do we want to add the target |
msluszniak
left a comment
There was a problem hiding this comment.
Tested all apps and besides one comment with some nits everything look cool.
Description
Refactor the public API surface, add package subpath exports for domain-specific imports, and standardize TSDoc documentation across all modules in preparation for documentation rewrite.
Package Subpaths
Add subpath exports in package.json for cv, llm, nlp, speech, math, and schema, enabling:
Add corresponding tsconfig.json path aliases for all example apps.
API Changes
export * from './constants'instead ofexport * as constantsllm.LLMGenerationStats,nlp.PiiEntity,schema.ConcreteDim, etc..DEFAULTaccessor (e.g.,models.objectDetection.SSDLITE320_MOBILENET_V3_LARGE.DEFAULT)Documentation
Hooks
Core
Implementation
RandomNormalOptionstype; useMath.random()instead ofDate.now()for seed defaultIntroduces a breaking change?
Type of change
Tested on
Testing instructions
Screenshots
Related issues
Closes #1380
Checklist
Additional notes