Skip to content

docs: correct the config-fallback comments on the NNLS warm-start settings (#506) - #504

Merged
Jammy2211 merged 1 commit into
mainfrom
feature/pixelization-fit-cpu-users-docs
Aug 28, 2026
Merged

Jammy2211 merged 1 commit into
mainfrom
feature/pixelization-fit-cpu-users-docs

Conversation

@Jammy2211

Copy link
Copy Markdown
Collaborator

Summary

Comment-only reword of the config-fallback explanation on the two NNLS warm-start settings,
nnls_warm_start_memo and nnls_warm_start_error_tolerance.

The except KeyError comments claimed that a workspace general.yaml "shadows" autoarray's, so
the hard-coded fallback "is the production default". That overstates what happens. A workspace
general.yaml normally omits these keys, and autonerves/autoconf's config-path list simply falls
through to autoarray's packaged general.yaml — measured from autolens_workspace, the resolved
values are True and 1.5, read from the packaged config, never from the fallback. The KeyError
branch fires only when the workspace config is the sole config path (isolated test configs push a
single directory), and it returns the same packaged default, so both routes resolve identically.

The reworded comments say exactly that. No behaviour, code or test changes; the __init__ docstring
entries for both parameters already stated the accurate "None (default) reads the packaged value"
and were left untouched.

API Changes

None — internal changes only.

Test Plan

python -m pytest test_autoarray/inversion/inversion/test_settings_dict.py test_autoarray/util/test_jax_nnls.py -q
# 18 passed

Additionally verified empirically from autolens_workspace that the workspace general.yaml carries
neither key and that conf.instance["general"]["inversion"][...] resolves to True / 1.5 from
autoarray's packaged config.

Closes nothing; part of PyAutoLabs/autolens_workspace#506.

Generated by the PyAutoLabs agent workflow.

…tings (#506)

The `except KeyError` comments on `nnls_warm_start_memo` and
`nnls_warm_start_error_tolerance` claimed a workspace `general.yaml`
shadows autoarray's, making the hard-coded fallback the production
default. In practice a workspace `general.yaml` omits these keys and
autoconf's config-path list falls through to autoarray's packaged value
(measured `True` / `1.5` from autolens_workspace). The fallback fires
only when the workspace config is the sole config path (isolated test
configs push one dir) and returns the same packaged value, so both
routes resolve identically.

Comments only; no code, behaviour or test changes.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01XySQZP6Npj4adZMkYZ96Bo
@Jammy2211 Jammy2211 added the pending-release PR queued for the next release build label Aug 28, 2026
@Jammy2211
Jammy2211 merged commit caabe2d into main Aug 28, 2026
3 checks passed
@Jammy2211
Jammy2211 deleted the feature/pixelization-fit-cpu-users-docs branch August 28, 2026 16:51
@Jammy2211 Jammy2211 removed the pending-release PR queued for the next release build label Sep 4, 2026
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