More detailed and accurate parameter descriptions#297
Conversation
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## dev #297 +/- ##
==========================================
- Coverage 92.37% 91.55% -0.83%
==========================================
Files 117 112 -5
Lines 5785 6048 +263
==========================================
+ Hits 5344 5537 +193
- Misses 441 511 +70
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Pull request overview
This PR updates model/docstring parameter descriptions across AstroPhot’s model zoo and tutorials, while also introducing several behavioral/API changes to PSF normalization, Gaussian/Airy profile definitions, and some model initializations.
Changes:
- Expand/clarify docstrings and tutorial notebook parameter explanations (sampling/integration, sky/PSF models, Sersic/Exponential/Gaussian, etc.).
- Refactor PSF normalization control to be a call-time argument (
normalize_psf) rather than a construction-time option/attribute. - Update/adjust a few model behaviors (e.g., Airy PSF parameterization, Fourier phase validity bounds, PixelBasisPSF weight initialization) and relax/skip parts of some tests.
Reviewed changes
Copilot reviewed 27 out of 27 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
| tests/test_psfmodel.py | Adjust PSF-model test skips/fit assertions; modifies pixelated PSF parameter assignment. |
| tests/test_model.py | Tweaks model skip logic for warp/fourier/truncated variants. |
| docs/source/tutorials/ModelZoo.ipynb | Updates Airy PSF example parameter name/value. |
| docs/source/tutorials/GettingStarted.ipynb | Adds printing of parameter descriptions in tutorial output. |
| docs/source/tutorials/AdvancedPSFModels.ipynb | Removes normalize_psf constructor usage from examples. |
| astrophot/models/sky_model_object.py | Changes __all__ style to tuple. |
| astrophot/models/psf_model_object.py | Updates PSFModel docs and changes normalization behavior/control surface. |
| astrophot/models/point_source.py | Removes unused torch-related imports/decorators; doc wording tweaks. |
| astrophot/models/planesky.py | Removes torch dependency in sky model; doc wording tweaks. |
| astrophot/models/pixelated_psf.py | Improves parameter description; removes torch decorator/import. |
| astrophot/models/pixelated_model.py | Improves parameter description; removes torch decorator/import. |
| astrophot/models/multi_gaussian_expansion.py | Updates PA description text. |
| astrophot/models/mixins/transform.py | Updates doc wording; adjusts Fourier phim valid range handling; changes truncation init. |
| astrophot/models/mixins/spline.py | Updates doc wording (Tensor→Array). |
| astrophot/models/mixins/sersic.py | Expands Re/Ie descriptions (effective radius/intensity wording). |
| astrophot/models/mixins/sample.py | Rewrites SampleMixin docstring with more detailed integration guidance. |
| astrophot/models/mixins/gaussian.py | Updates Gaussian docstring and parameter description text. |
| astrophot/models/mixins/exponential.py | Expands Re/Ie descriptions for exponential profiles. |
| astrophot/models/group_psf_model.py | Updates PSFGroupModel docs; changes normalization control surface. |
| astrophot/models/gaussian_ellipsoid.py | Removes torch decorator/import. |
| astrophot/models/func/gaussian.py | Changes Gaussian functional form/normalization. |
| astrophot/models/flatsky.py | Clarifies I0 parameter description/units. |
| astrophot/models/bilinear_sky.py | Expands docs; changes PA/scale dynamic flags; refactors initialization. |
| astrophot/models/batch_model_object.py | Improves RST link formatting and batch-parameter explanation. |
| astrophot/models/basis_psf.py | Expands docstring; changes default weights initialization (now randomized + scaled). |
| astrophot/models/airy.py | Refactors Airy PSF parameters (aRL→R1), updates docs and sampling expression. |
| astrophot/fit/lm.py | Removes torch import and torch.no_grad() decorators. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
No description provided.