docs(tutorial_5): correct stale parameter-filtering prose#25
Merged
Conversation
The tutorial fits a two-component model (Gaussian + Exponential, 6 parameters), but the without_paths section still claimed that removing gaussian.centre leaves '2 parameters; the normalization and sigma' — text left over from when this tutorial fitted a Gaussian alone. The run prints 5 values. without_paths was always correct; the prose was not. Also in the same section: - 'in-profile_1d with the PyAutoFIT API' -> 'in-line with the PyAutoFit API' (a bad find/replace of 'line' -> 'profile_1d'; only occurrence) - closed an unclosed parenthesis in a print label Verified: script exits 0, printed counts now match the prose. Notebook regenerated. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Found while clearing this tutorial's stale NEEDS_FIX marker (PyAutoLabs/PyAutoFit#1411). Script always exited 0 — this is teaching correctness, not a crash.
The tutorial composes a two-component model (
Gaussian+Exponential= 6 parameters), but thewithout_pathssection claimed removinggaussian.centreleaves "2 parameters; thenormalizationandsigma" — stale text from when it fitted a Gaussian alone. The run prints 5.without_pathswas behaving correctly the whole time.A learner saw five numbers where the text promised two, with no explanation — undermining the exact filtering concept the section teaches.
Also fixed in the same section:
in-profile_1d with the PyAutoFIT API→in-line with the PyAutoFit API(bad find/replace ofline→profile_1d; verified the only occurrence in the repo)Checked the neighbouring
with_pathssections as well — their "containing only the Gaussian centre" labels are correct (1 value), so they survived the model change intact.Verified: exit 0, printed counts now match the prose. Notebook regenerated.
🤖 Generated with Claude Code