-
Notifications
You must be signed in to change notification settings - Fork 591
Description
Describe the bug
The website currently places Modality Signal under the heuristic tutorial group, but the implementation and surrounding docs treat modality as a router-owned detector with learned classification support.
Today the docs say modality "sits under heuristic" in website/docs/tutorials/signal/heuristic/modality.md, and the signal overview links modality from the heuristic section in website/docs/tutorials/signal/overview.md.
That taxonomy looks wrong or at least misleading, because modality is wired through global.model_catalog.modules.modality_detector, supports classifier and hybrid detection methods, and has dedicated training assets for a modality routing classifier.
To Reproduce
- Open
website/docs/tutorials/signal/overview.md. - See
modalitylisted underHeuristic Signalsand linked to./heuristic/modality. - Open
website/docs/tutorials/signal/heuristic/modality.md. - Read the statement that modality "sits under
heuristic". - Compare that with the implementation and model-facing docs:
src/semantic-router/pkg/config/image_gen_plugin.gosrc/vllm-sr/cli/models.pysrc/training/model_classifier/modality_routing_classifier/README.md
Expected behavior
modality should be documented as a learned signal on the website, and the overview/navigation should move it out of the heuristic section.
If maintainers want to preserve the fact that modality also supports keyword fallback, the docs should still avoid presenting it as heuristic-only. A learned page with a note about keyword/hybrid modes would be less misleading.
Affected layer
signal
Additional context
Relevant implementation details:
src/semantic-router/pkg/config/image_gen_plugin.godefines modality detection methodsclassifier,keyword, andhybrid.src/semantic-router/pkg/classification/classifier.goimplements classifier-first / hybrid modality detection.src/semantic-router/pkg/config/canonical_global.goexposesglobal.model_catalog.modules.modality_detectoralongside other router-owned model modules.src/vllm-sr/cli/models.pydocumentsModalityRuleas reading detection config frommodality_detector.src/training/model_classifier/modality_routing_classifier/README.mddocuments the dedicated modality routing classifier.
Likely docs/files to update:
website/docs/tutorials/signal/overview.mdwebsite/docs/tutorials/signal/heuristic/modality.md- potentially a new
website/docs/tutorials/signal/learned/modality.md
This looks like a contained docs issue and a reasonable help wanted candidate.
Metadata
Metadata
Assignees
Labels
Type
Projects
Status