Docs audit follow-up: performance-tips appendix, gallery and contribution fixes#18
Open
TomaSusi wants to merge 3 commits into
Open
Docs audit follow-up: performance-tips appendix, gallery and contribution fixes#18TomaSusi wants to merge 3 commits into
TomaSusi wants to merge 3 commits into
Conversation
contribute.md's gallery instructions still described the retired examples.yml + generator-script workflow (files parked as .bak since the 1.0.7 verification pass); they now describe the current direct editing of examples.md. The deployment sentence now explains the stable (release, site root) / dev (main, /dev/) publishing model, and a Windows-style path separator is fixed. The complete animations example notebook (thumbnail and all) was never listed in the gallery; it now has a card and toctree entry, and the gallery's own stale gallery.yml sentence points at the contribute guide instead. Drops the exclude pattern for the nonexistent reference/benchmarks dir. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Fleshes out the long-hidden outline into a full page: simulation parameters (gpts, slices, cell size, scan and ensemble sampling), PRISM, memory management (reduce early, chunk size, workers), FFT library/threads/grid-size choices, and float precision. Each claim is backed by a short executed demonstration (with a warmup run so the first timing isn't dominated by FFT planning); the FFT default is corrected from the outline's MKL claim to the actual FFTW. Executed against abTEM v1.0.10; widget check clean. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Turns the 6-cell stub into a full page: base vs ensemble axes (with an exploded defocus-series figure), the abtem.distributions factories and their weights, the ensemble_mean tag and how reduction applies it (explicitly via reduce_ensemble or automatically during detection, demonstrated by comparing lazy measurement shapes), multidimensional outer-product ensembles, and how ensembles map onto Dask blocks for parallelization. Executed against abTEM v1.0.10; widget check clean. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Member
Author
|
Added the ensembles appendix (issue #16) to this PR in 99468ac — same pattern as performance-tips: executed against abTEM v1.0.10, widget check clean, included in the TOC. 🤖 Generated with Claude Code |
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
Follow-up from a docs coverage audit. Stacked on #9 (base
autodoc2-experiment); retarget tomainafter #9 merges.user_guide/appendix/performance_tips.ipynb) — the long-hidden outline is now a full page covering simulation parameters (gpts, slices, cell size, scan/ensemble sampling), PRISM, memory management (reduce early, chunk size, workers), FFT library/threads/grid-size choices, and float precision, each backed by a short executed demonstration (run against abTEM v1.0.10). Corrects the outline's stale claim that MKL is the default FFT (it's FFTW). Now included in the TOC — easy to re-hide if it needs more work.abtem/contribute.md) — the gallery instructions still described the retiredexamples.yml+ generator-script workflow; they now describe direct editing ofexamples.md. The deployment sentence now explains the stable (release → site root) / dev (main →/dev/) model.gallery.ymlsentence now points at the contribute guide.reference/benchmarksdirectory.The audit's remaining findings became a backlog of 8 scoped issues: #10 (MTF/MCF detector response), #11 (magnetism.gpaw), #12 (widgets tutorial), #13 (parametrizations/integrals), #14 (LaplaceOperator), #15 (ptychography beyond ePIE), #16 (ensembles appendix), #17 (inelastic quickstarts). The four complete-but-hidden tutorials (epie, visualizations, custom_simulation_objects, plasmons) deliberately stay hidden; several issues point at them as draft material.
Test plan
jupyter-bookbuild: warning count drops 15 → 13 (exactly the two orphan-page warnings resolved by this PR); no new warningsperformance_tips.ipynbexecuted end-to-end in the abtem-py3.13 env; widget-state check clean🤖 Generated with Claude Code