Skip to content

Redesign docs around decoupled optics/sensor/network architecture#107

Merged
singer-yang merged 3 commits intorestructurefrom
copilot/update-documentation-structure
Feb 16, 2026
Merged

Redesign docs around decoupled optics/sensor/network architecture#107
singer-yang merged 3 commits intorestructurefrom
copilot/update-documentation-structure

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Feb 16, 2026

DeepLens documentation still described an older package layout and made the architecture harder to parse after the codebase split into three decoupled parts. This PR updates core docs to present the system as optics + sensor + network, with Camera as the composition layer.

  • Architecture narrative (user guide)

    • Reworked docs/user_guide/architecture.rst overview to center on the three decoupled modules:
      • deeplens.optics
      • deeplens.sensor
      • deeplens.network
    • Clarified deeplens.camera.Camera as the wrapper that composes optics and sensor simulation.
    • Added a dedicated Network section to complete the module-level architecture story.
  • Repository structure docs (top-level + quickstart)

    • Updated structure blocks in:
      • README.md
      • docs/quickstart.rst
    • Removed outdated references to lens files at deeplens/ root and replaced with the current module-first layout.
    • Explicitly documented camera.py as the composition entry point.
  • Readability/consistency cleanup

    • Aligned terminology across docs to consistently use the decoupled module framing.
    • Tightened section wording to reduce duplication and improve scanability.
deeplens/
├── optics/   # optical simulation and lens models
├── sensor/   # sensor and ISP simulation
├── network/  # surrogate + reconstruction networks
└── camera.py # composition wrapper (optics + sensor)

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI and others added 2 commits February 16, 2026 18:09
Co-authored-by: singer-yang <25293821+singer-yang@users.noreply.github.com>
Co-authored-by: singer-yang <25293821+singer-yang@users.noreply.github.com>
Copilot AI changed the title [WIP] Update documentation to align with new code structure Redesign docs around decoupled optics/sensor/network architecture Feb 16, 2026
Copilot AI requested a review from singer-yang February 16, 2026 18:12
@singer-yang singer-yang marked this pull request as ready for review February 16, 2026 18:13
@singer-yang singer-yang merged commit e1a23bb into restructure Feb 16, 2026
@singer-yang singer-yang deleted the copilot/update-documentation-structure branch February 20, 2026 14:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants