Skip to content

Commit 80f447a

Browse files
author
James Nightingale
authored
Merge pull request #656 from PyAutoLabs/feature/config-leaf-comments
Document remaining configuration leaf settings
2 parents 0f12fac + 171eacc commit 80f447a

4 files changed

Lines changed: 16 additions & 16 deletions

File tree

‎autoarray/config/general.yaml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@ inversion:
2222
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.
2323
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.
2424
numba:
25-
use_numba: true
26-
cache: true
27-
nopython: true
28-
parallel: false
25+
use_numba: true # If True, use numba-accelerated mapper and Sibson interpolation paths when eligible.
26+
cache: true # If True, cache numba compiled functions on disk.
27+
nopython: true # If True, require numba compilation without the Python interpreter.
28+
parallel: false # If True, enable numba parallel compilation.
2929
structures:
3030
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‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
1-
version: 1
2-
disable_existing_loggers: false
1+
version: 1 # Python logging dictionary schema version (1).
2+
disable_existing_loggers: false # If True, disable existing non-root loggers when configuring logging.
33

44
handlers:
55
console:
6-
class: logging.StreamHandler
7-
level: INFO
8-
stream: ext://sys.stdout
9-
formatter: formatter
6+
class: logging.StreamHandler # Python handler class used to emit log records.
7+
level: INFO # Minimum logging severity emitted by this handler or logger.
8+
stream: ext://sys.stdout # Output stream receiving console log records.
9+
formatter: formatter # Name of the formatter applied by this handler.
1010

1111
root:
12-
level: INFO
13-
handlers: [ console ]
12+
level: INFO # Minimum logging severity emitted by this handler or logger.
13+
handlers: [ console ] # Names of handlers receiving root logger records.
1414

1515
formatters:
1616
formatter:
17-
format: '%(asctime)s - %(name)s - %(levelname)s - %(message)s'
17+
format: '%(asctime)s - %(name)s - %(levelname)s - %(message)s' # Python logging format string applied to each log record.

‎autoarray/config/visualize/general.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@ general:
77
zoom_around_mask: true # If True, plots of data structures with a mask automatically zoom in the masked region.
88
output_format: show # Default output format: "show" displays the figure interactively via plt.show(), "png"/"pdf"/etc. saves to file.
99
inversion:
10-
reconstruction_vmax_factor: 0.5
10+
reconstruction_vmax_factor: 0.5 # Legacy reconstruction colour-scale factor; no reader found in the current library source.
1111
total_mappings: 5 # The maximum number of source clumps drawn by subplot_mappings.
1212
mappings_threshold: 0.5 # A source pixel joins a clump if its reconstructed value exceeds this fraction of the reconstruction's maximum.
1313
mappings_min_pixels: 3 # Connected groups of source pixels smaller than this are not drawn as a clump.
1414
zoom:
15-
plane_percent: 0.01
15+
plane_percent: 0.01 # Fraction of peak image brightness used to determine the plotted plane extent.
1616
inversion_percent: 0.01 # Plots of an Inversion's reconstruction use the reconstructed data's bright value multiplied by this factor.
1717
units:
1818
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‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
dataset: # Settings for plots of all datasets (e.g. Imaging, Interferometer).
77
subplot_dataset: true # Plot subplot containing all dataset quantities (e.g. the data, noise-map, etc.)?
88
imaging: # Settings for plots of imaging datasets (e.g. Imaging)
9-
psf: false
9+
psf: false # If True, output the imaging dataset PSF plot.
1010
fit: # Settings for plots of all fits (e.g. FitImaging, FitInterferometer).
1111
subplot_fit: true # Plot subplot of all fit quantities for any dataset (e.g. the model data, residual-map, etc.)?
1212
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.)?

0 commit comments

Comments
 (0)