docs: sync model and detector references - #150
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
Description
## Model and detector specificationssection toREADME.md(placed after "What I built vs third-party components") listingmidas_small,dpt_hybrid, anddpt_largewith canonical IDs, ONNX filenames, and input sizes.docs/models-colormaps-metrics.mdto include ONNX filenames and to state that ONNX is optional for standard PyTorch usage.POST /detectand/api/detectdocs indocs/api-reference.mdto explicitly identify the local TorchVision COCO detector (fasterrcnn_mobilenet_v3_large_320_fpn), note the internal 960 px cap, response metadata (detections,model,device_used,latency_ms,resolution), MPS→CPU resolution, and CPU retry behavior.docs/security.mdwording about first-time model/detector weight caching and confirmed raw image payloads are not logged by telemetry.Testing
scripts/ci.sh docs-contractandpython scripts/validate_docs.py; both passed.scripts/ci.sh workflow-policywhich passed.scripts/ci.sh allpartially:workflow-policy,docs-contract,black,ruff, andmypysucceeded, whilepytestcollection failed in this environment due to missing runtime/test dependencies (fastapi,numpy,pydantic,torch), which are expected to be present in a full test environment; this is an environmental limitation and not a code issue.git diff --checkshows no spacing or trailing-whitespace problems and committed the changes as a documentation-only update.Codex Task