SimpleDet Docs

Developer guide

Repository structure, module responsibilities, extension points, and documentation workflow for the current suite-based architecture.

Overview Quickstart Core Concepts API Reference

Use this page when you are modifying the repo itself rather than only consuming the public API.

Repository structure

  • simpledet/simpledet/suite/ for specs, builders, and compiler
  • simpledet/simpledet/_model_resolution.py for runtime adaptation
  • simpledet/simpledet/api.py for the pipeline wrapper
  • simpledet/simpledet/detectors/ for compatibility helpers
  • tests/ for unit tests and repo audit
  • docs/ for this static HTML site

How to add a new detector family

  1. Add the architecture and family mapping in suite/catalog.py.
  2. Add the template mapping in suite/compiler.py.
  3. Extend compiler logic only if the family needs custom adaptation rules.
  4. Add coverage in tests/test_suite.py.

Testing

PYTHONPATH=simpledet python3 -m unittest discover -s tests -p 'test*.py'
python3 scripts/verify_docs.py