Document remaining configuration leaf settings

autoarray/config/general.yaml

@@ -22,9 +22,9 @@ inversion:
   interferometer_route: null          # Force the interferometer curvature route for benchmarking: null (default) routes by interferometer_numba_nnz_per_source_max; "fft" always uses the FFT route; "numba" uses the numba direct_conv route whenever it can represent the inversion (NumPy, one mapper, no linear functions, no over-sampling), overriding the gate and the 0 kill switch.
   interferometer_direct_conv_symmetric_max_work_fraction: 0.7 # When the serial (numba parallel: false) direct_conv curvature route runs, use the symmetric row-restricted kernel (curvature_direct_conv_symmetric: source columns ranked by their top extent row, each convolving only the extent rows later-ranked columns span and only each row's mask x-range, then a mirror pass) when its geometry work fraction (its convolution work / the full kernel's) is at or below this value. Same F to round-off (computed entries bit-identical). Synthetic Aris-512 geometry (compact columns): f ~0.41, 1.81-1.90x single-thread on RAL; Aris's real 512 Delaunay mesh (multiply imaged, tall columns): f ~0.51, ~1.46x measured (PyAutoArray#635). The route cost model scales t_dc by min(1, 1.32 x work fraction), so the kernel wins below f ~0.76; 0.7 keeps a predicted gain >= 1.08x. Set 0 to always use the full kernel. The parallel kernel is unaffected.
 numba:
-  use_numba: true
-  cache: true
-  nopython: true
-  parallel: false
+  use_numba: true # If True, use numba-accelerated mapper and Sibson interpolation paths when eligible.
+  cache: true # If True, cache numba compiled functions on disk.
+  nopython: true # If True, require numba compilation without the Python interpreter.
+  parallel: false # If True, enable numba parallel compilation.
 structures:
   native_binned_only: false           # If True, data structures are only stored in their native and binned format. This is used to reduce memory usage in autocti.

autoarray/config/logging.yaml

@@ -1,17 +1,17 @@
-version: 1
-disable_existing_loggers: false
+version: 1 # Python logging dictionary schema version (1).
+disable_existing_loggers: false # If True, disable existing non-root loggers when configuring logging.
 
 handlers:
   console:
-    class: logging.StreamHandler
-    level: INFO
-    stream: ext://sys.stdout
-    formatter: formatter
+    class: logging.StreamHandler # Python handler class used to emit log records.
+    level: INFO # Minimum logging severity emitted by this handler or logger.
+    stream: ext://sys.stdout # Output stream receiving console log records.
+    formatter: formatter # Name of the formatter applied by this handler.
 
 root:
-  level: INFO
-  handlers: [ console ]
+  level: INFO # Minimum logging severity emitted by this handler or logger.
+  handlers: [ console ] # Names of handlers receiving root logger records.
 
 formatters:
   formatter:
-    format: '%(asctime)s - %(name)s - %(levelname)s - %(message)s'
+    format: '%(asctime)s - %(name)s - %(levelname)s - %(message)s' # Python logging format string applied to each log record.

autoarray/config/visualize/general.yaml

@@ -7,12 +7,12 @@ general:
   zoom_around_mask: true                # If True, plots of data structures with a mask automatically zoom in the masked region.
   output_format: show                   # Default output format: "show" displays the figure interactively via plt.show(), "png"/"pdf"/etc. saves to file.
 inversion:
-  reconstruction_vmax_factor: 0.5
+  reconstruction_vmax_factor: 0.5 # Legacy reconstruction colour-scale factor; no reader found in the current library source.
   total_mappings: 5                     # The maximum number of source clumps drawn by subplot_mappings.
   mappings_threshold: 0.5               # A source pixel joins a clump if its reconstructed value exceeds this fraction of the reconstruction's maximum.
   mappings_min_pixels: 3                # Connected groups of source pixels smaller than this are not drawn as a clump.
 zoom:
-  plane_percent: 0.01
+  plane_percent: 0.01 # Fraction of peak image brightness used to determine the plotted plane extent.
   inversion_percent: 0.01               # Plots of an Inversion's reconstruction use the reconstructed data's bright value multiplied by this factor.
 units:
   use_scaled: true                      # Whether to plot spatial coordinates in scaled units computed via the pixel_scale (e.g. arc-seconds) or pixel units by default.

autoarray/config/visualize/plots.yaml

@@ -6,7 +6,7 @@
 dataset:                                   # Settings for plots of all datasets (e.g. Imaging, Interferometer).
   subplot_dataset: true                    # Plot subplot containing all dataset quantities (e.g. the data, noise-map, etc.)?
 imaging:                                   # Settings for plots of imaging datasets (e.g. Imaging)
-   psf: false
+   psf: false # If True, output the imaging dataset PSF plot.
 fit:                                       # Settings for plots of all fits (e.g. FitImaging, FitInterferometer).
   subplot_fit: true                        # Plot subplot of all fit quantities for any dataset (e.g. the model data, residual-map, etc.)?
   subplot_fit_log10: false                  # Plot subplot of all fit quantities for any dataset using log10 color maps (e.g. the model data, residual-map, etc.)?