Skip to content

improve docstrings for autoarray/inversion package and update fit log…#229

Merged
Jammy2211 merged 1 commit intomainfrom
feature/documentation-fit
Mar 9, 2026
Merged

improve docstrings for autoarray/inversion package and update fit log…#229
Jammy2211 merged 1 commit intomainfrom
feature/documentation-fit

Conversation

@Jammy2211
Copy link
Owner

…_evidence

inversion package:

  • abstract.py: fix wrong Parameters section in AbstractInversion.init (was listing data/noise_map; now correctly lists dataset/linear_obj_list/settings/xp); remove spurious dict_values param from has() method
  • imaging/abstract.py: fix same wrong Parameters section (data/noise_map → dataset/...)
  • interferometer/abstract.py: fix wrong Parameters section (noise_map/transformer → dataset/...); add docstring to fast_chi_squared property
  • dataset_interface.py: remove spurious over_sampler/border_relocator params; fix "imaigng" typo
  • inversion_interferometer_util.py: fix wrong param name image → visibilities
  • inversion_util.py: add missing params add_to_curvature_diag/no_regularization_index_list/ settings/xp to curvature_matrix_via_mapping_matrix_from; fix "transfomed" typo
  • linear_obj.py: fix "piels" → "pixels" typo; fix "regularizaiton" typo
  • mappers/abstract.py: fix wrong Parameters in Mapper.init (was listing source_plane_data_grid/source_plane_mesh_grid/adapt_data/mesh_weight_map; now lists actual params interpolator/regularization/settings/image_plane_mesh_grid/xp); fix "unfamliar"/"pxelization"/"annd" typos
  • imaging/inversion_imaging_util.py: fix "PSf" → "PSF" typo

fit package (retrospective improvements using inversion context):

  • fit_util.py: expand log_evidence_from docstring with full mathematical formula (χ² + s^T H s + ln det(F+H) - ln det(H) + Σ ln 2πσ²) and paper references
  • fit_dataset.py: expand log_evidence property with same full formula
  • fit_interferometer.py: expand log_evidence with full formula; mention fast_chi_squared

…_evidence

inversion package:
- abstract.py: fix wrong Parameters section in AbstractInversion.__init__
  (was listing data/noise_map; now correctly lists dataset/linear_obj_list/settings/xp);
  remove spurious dict_values param from has() method
- imaging/abstract.py: fix same wrong Parameters section (data/noise_map → dataset/...)
- interferometer/abstract.py: fix wrong Parameters section (noise_map/transformer → dataset/...);
  add docstring to fast_chi_squared property
- dataset_interface.py: remove spurious over_sampler/border_relocator params;
  fix "imaigng" typo
- inversion_interferometer_util.py: fix wrong param name image → visibilities
- inversion_util.py: add missing params add_to_curvature_diag/no_regularization_index_list/
  settings/xp to curvature_matrix_via_mapping_matrix_from; fix "transfomed" typo
- linear_obj.py: fix "piels" → "pixels" typo; fix "regularizaiton" typo
- mappers/abstract.py: fix wrong Parameters in Mapper.__init__ (was listing
  source_plane_data_grid/source_plane_mesh_grid/adapt_data/mesh_weight_map;
  now lists actual params interpolator/regularization/settings/image_plane_mesh_grid/xp);
  fix "unfamliar"/"pxelization"/"annd" typos
- imaging/inversion_imaging_util.py: fix "PSf" → "PSF" typo

fit package (retrospective improvements using inversion context):
- fit_util.py: expand log_evidence_from docstring with full mathematical formula
  (χ² + s^T H s + ln det(F+H) - ln det(H) + Σ ln 2πσ²) and paper references
- fit_dataset.py: expand log_evidence property with same full formula
- fit_interferometer.py: expand log_evidence with full formula; mention fast_chi_squared

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@Jammy2211 Jammy2211 merged commit e21a282 into main Mar 9, 2026
8 checks passed
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.

1 participant