Improve docs quality: explanations, terminology, missing sections#107
Merged
Conversation
…ology - Fix CLI override example: graph.theta.estimator.optimizer.lr → .estimator.lr (no nested optimizer group; all params are flat) - Clarify buffer.max_samples: "disfavoured" → "permanently removed (FIFO)" - Fix gamma inline comment in configuration.md (was "0=posterior, 1=prior" which conflated two different framings; now "0=tight, higher=broader") - Add missing sample: config section documentation with posterior/ppd examples - Add scaffolds and resample inline comments explaining their purpose - flow-density.md: note that sbi/nflows net_types require pip install [sbi]; zuko_* types work by default; clarify "recommended" applies when sbi installed - Fix DynamicSVD docstring: "Returns zeros" → "Returns random noise" (actual code) - Replace SNPE_gaussian with GaussianFullCov in examples/04_gaussian and examples/05_linear_regression comment headers - Fix examples/01_minimal: config.yaml → config.yml in resume comment - product.md: improve cosine/sine/uvol distribution descriptions with use-cases; add param_dim vs full_param_dim note; clarify lognormal restriction with reason - embeddings.md: add ToeplitzWhitener section and class reference; expand DynamicSVD YAML example with buffer_size and momentum; clarify DiagonalWhitener dim requirement - api/index.md: mark flow_density, stepwise_base, networks, embedded_posterior as internal in the package tree - gaussian.md: add prior_epochs to cross-ref list; add note explaining that gamma has different semantics in GaussianFullCov vs Flow - flow.md: rewrite gamma explanation to avoid "amortization" framing which has a different technical meaning in the SBI literature - getting-started.md: add shape comments to simulator and observation examples; add note explaining what happens when embedding is omitted; expand ppd description in CLI table Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #107 +/- ##
=======================================
Coverage 10.42% 10.42%
=======================================
Files 30 30
Lines 3896 3896
=======================================
Hits 406 406
Misses 3490 3490
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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.
Summary
Second-pass documentation quality pass — all non-functional issues: missing explanations, confusing phrasing, stale terminology, and incomplete sections. No code logic changed (except one docstring fix in
svd.py).Wrong/misleading content fixed
graph.theta.estimator.optimizer.lr— wrong path; correct flat path isgraph.theta.estimator.lrbuffer.max_samplesdescription said "disfavoured" (ambiguous internal term); now says "permanently removed"gammacomment inconfiguration.mdsaid "0=posterior, 1=prior" — inconsistent withflow.md; unified to "0=tight around posterior, higher=broader"DynamicSVD.forwarddocstring said "Returns zeros before first SVD update"; actual code returnstorch.randn— fixedMissing documentation added
sample:config section was used in every example but never documented — added withposterior/ppdexamplesscaffoldsandresamplenode keys had no explanation beyond a one-word comment — clarified inlineflow-density.md:sbi/nflowsnet types (nsf,maf, etc.) requirepip install falcon-sbi[sbi]— now stated;zuko_*types work by defaultToeplitzWhitener: exported fromfalcon.embeddingsbut missing fromembeddings.md— added with YAML exampleparam_dimvsfull_param_dimdistinction inProduct— added note inproduct.mdgammasemantics differ betweenFlowandGaussianFullCov— added explicit note ingaussian.mdTerminology / naming fixes
SNPE_gaussian→GaussianFullCovinexamples/04_gaussian/config.ymlandexamples/05_linear_regression/config.yml(old internal name; class isGaussianFullCov)config.yaml→config.ymlinexamples/01_minimal/config.ymlresume commentapi/index.mdpackage tree:flow_density,stepwise_base,networks,embedded_posteriornow marked(internal)Explanation improvements
cosine/sine/uvoldistribution types now include use-cases (e.g. "pdf ∝ sin(θ) — use for declination-like angles")lognormalrestriction note now explains why (hypercubeCDF path not implemented)DynamicSVDYAML example expanded withbuffer_sizeandmomentum;DiagonalWhitenerdimclarified as "must match flattened input size"embedding:is omittedppdCLI entry now has a description: "forward model evaluated at posterior samples"gammainflow.md: removed "amortization" framing (has a different meaning in the SBI literature); replaced with plain description of proposal breadthTest plan
falcon launch buffer.max_samples=32768 graph.theta.estimator.lr=0.001accepted by CLImkdocs build)from falcon.embeddings import ToeplitzWhitenersucceeds🤖 Generated with Claude Code