Skip to content

Align lens documentation with current API defaults and examples#104

Merged
singer-yang merged 3 commits intoimgsimfrom
copilot/update-project-documentation
Feb 6, 2026
Merged

Align lens documentation with current API defaults and examples#104
singer-yang merged 3 commits intoimgsimfrom
copilot/update-project-documentation

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Feb 6, 2026

The lens documentation drifted from the current APIs (defaults, parameter ordering, and example usage). This updates docs to match the updated functions and conventions.

  • API reference alignment
    • Updated Lens/GeoLens signatures, defaults, and parameter notes (e.g., sampling counts, wavelength defaults, depth conventions).
  • Example correctness
    • Reworked optimization, PSF, and rendering snippets to use current method names and parameter shapes.
    • Removed stale calls and clarified performance/accuracy trade-offs.

Example (updated usage):

params = lens.get_optimizer_params(lrs=[1e-4, 1e-4, 1e-2, 1e-4])
optimizer = torch.optim.Adam(params)

psf = lens.psf(points=[0.0, 0.0, -1000.0], spp=2048)
img_rendered = lens.render(img, depth=-1000)
Original prompt

based on the code edits, check the corresponding project docs, update the documentation if the existing doc doesnot match with the updated functions


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Copilot AI and others added 2 commits February 6, 2026 15:29
Co-authored-by: singer-yang <25293821+singer-yang@users.noreply.github.com>
Co-authored-by: singer-yang <25293821+singer-yang@users.noreply.github.com>
@singer-yang singer-yang self-requested a review February 6, 2026 15:38
@singer-yang singer-yang marked this pull request as ready for review February 6, 2026 15:39
Copilot AI changed the title [WIP] Update project documentation to match updated functions Align lens documentation with current API defaults and examples Feb 6, 2026
@singer-yang singer-yang merged commit 8243ce8 into imgsim Feb 6, 2026
1 check passed
@singer-yang singer-yang deleted the copilot/update-project-documentation branch February 20, 2026 14:12
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