docs: tutorial-completeness CI check + normalize tutorials (phase 3)#16
Merged
Merged
Conversation
…ToLens#26) Apply the tutorial-completeness guard from HowToLens to HowToFit: - Add .github/scripts/check_tutorials_complete.py + tutorials_complete.yml CI — every non-stub tutorial must reach a terminal __Wrap Up__/__Summary__ section. - Normalize four complete-but-unmarked tutorials with the terminal marker: tutorial_5_results_and_samples (ended on a bare "Finish." docstring), tutorial_optional_hierarchical_individual (prose conclusion), tutorial_5_expectation_propagation and tutorial_optional_hierarchical_ep (both end on intentional optional commented-out example code — a wrap-up section is appended framing that code as optional). No genuinely-truncated tutorials were found in HowToFit. Smoke 10/10. Notebooks + catalogue regenerated. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01KExk2jkn2ya21b6NZLALpB
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
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.
Overview
Phase 3 (HowToFit) of PyAutoLabs/HowToLens#26 — applying the tutorial-completeness guard to HowToFit. No genuinely-truncated tutorials were found here; the work is normalizations + the CI check.
What changed
.github/scripts/check_tutorials_complete.py+tutorials_complete.ymlCI — every non-stub tutorial must contain a terminal__Wrap Up__/__Summary__section. A truncated script never reaches its wrap-up, so absence of the marker reliably flags lost content.tutorial_5_results_and_samples— ended on a bareFinish.docstring; replaced with a real__Wrap Up__.tutorial_optional_hierarchical_individual— ended on a prose conclusion; add the marker.tutorial_5_expectation_propagationandtutorial_optional_hierarchical_ep— both end on intentional optional commented-out example code (mean-field inspection / the expensive EPoptimisecall, commented for cost). A__Wrap Up__section is appended that frames the commented code as optional, so the tutorials read as complete without removing the reference snippets.Scripts Changed
scripts/chapter_1_introduction/tutorial_5_results_and_samples.py— replace bareFinish.with a real__Wrap Up__scripts/chapter_3_graphical_models/tutorial_optional_hierarchical_individual.py— add__Wrap Up__marker (already complete)scripts/chapter_3_graphical_models/tutorial_5_expectation_propagation.py— append__Wrap Up__(ends on optional commented code)scripts/chapter_3_graphical_models/tutorial_optional_hierarchical_ep.py— append__Wrap Up__(ends on optional commented code).github/scripts/check_tutorials_complete.py— new tutorial-completeness linter.github/workflows/tutorials_complete.yml— new CI workflow running the linternotebooks/**— regeneratedValidation checklist (--auto)
smoke_tests.txt10/10 (including editedtutorial_5_expectation_propagation), run on this branch.Final part of the 3-repo rollout (HowToLens #27 → HowToGalaxy #19 → this). With all three merged, HowToLens#26 can close.
🤖 Generated with Claude Code
https://claude.ai/code/session_01KExk2jkn2ya21b6NZLALpB