docs: expand quick-update cookbook + add config flag defaults#67
Merged
Conversation
Rewrites the __Live Quick-Update Visualization__ section in the analysis cookbook to document live_visual_update alongside background_quick_update, adds an Analysis API surface subsection covering perform_quick_update, supports_background_update, and supports_jax_visualization, mentions the Fitness.manage_quick_update dispatcher, and adds a custom-override example. Mirrors the two library defaults into config/general.yaml under updates: and hpc: so workspace configs do not shadow them as unset. Refs #66. Co-Authored-By: Claude Opus 4.7 (1M context) <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.
Summary
Completes items 3 and 4 of
PyAutoPrompt/issued/on_the_fly_docs.md. Expands the analysis cookbook to fully document the on-the-fly quick-update machinery — both library flags (background_quick_update,live_visual_update), the Analysis API surface (perform_quick_update,supports_background_update,supports_jax_visualization), theFitness.manage_quick_updatedispatcher, and a custom-override example. Mirrors the two library config defaults intoconfig/general.yaml.Scripts Changed
scripts/cookbooks/analysis.py— rewrote the__Live Quick-Update Visualization__section: documentslive_visual_updateseparately frombackground_quick_update(the two are independent), adds an Analysis API surface subsection (perform_quick_update,supports_background_update,supports_jax_visualization), mentionsFitness.manage_quick_update, updates the commented API-shape example to show both flags, and adds a commentedperform_quick_updateoverride example. Tightens the Jupyter / script display surface description to nameIPython.display.update_displaywith a stabledisplay_id(the actual shipped mechanism) and the matplotlib viewer subprocess for script mode.config/general.yaml— appendsquick_update_background: falseandlive_visual_update: falseunder bothupdates:andhpc:with explanatory comments.Test Plan
python scripts/cookbooks/analysis.pyruns underPYAUTO_TEST_MODE=1cookbooks/analysis.pyrenders the new section cleanlyRefs #66.
🤖 Generated with Claude Code