Fix docs: flat YAML format, correct class/param names, CLI accuracy#106
Merged
Conversation
…ames Two-pass audit of all docs against source code. Key fixes: - Replace fictional nested YAML groups (loop/network/optimizer/inference) with the correct flat format — nested keys would raise TypeError at runtime - Rename Gaussian → GaussianFullCov throughout (class never existed as Gaussian) - scheduler_patience → lr_patience (actual Flow/GaussianFullCov param name) - use_best_models_during_inference → use_best_models - Logged metric names: loss/train → train:loss, loss/val → val:loss - pip install -e ".[monitor]" → ".[all]" (monitor extra never existed) - pip install -e . → ".[all]" in docs/index.md (Flow requires [sbi] extra) - paths.import → paths.imports (correct key name, list type) - Python 3.9+ → 3.10+ (matches pyproject.toml) - Remove falcon monitor CLI (doesn't exist; TUI is part of falcon launch) - Add ppd to falcon sample synopsis - Add setup() to BaseEstimator members list - Add add_node() to Graph members list - DiagonalWhitener YAML example: add required dim argument - Remove non-existent FlowConfig/NetworkConfig/OptimizerConfig/InferenceConfig class references from flow.md - Add missing Flow params: prior_epochs, betas, device - Add undocumented buffer fields: simulate_chunk_size, initial_samples_path - lognormal distribution: note it only works with mode="standard_normal" - Update package tree in api/index.md (gaussian_fullcov, stepwise_base, etc.) - Fix GaussianFullCov class reference path (gaussian_fullcov module) - buffer.max_epochs → buffer.max_samples in CLI override example 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 #106 +/- ##
=======================================
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
Two-pass audit of all documentation against the actual source code, fixing incorrect or misleading content that would cause failures if followed verbatim.
Critical fixes
Flat YAML format (
docs/api/flow.md,docs/api/gaussian.md,docs/configuration.md,docs/getting-started.md): The docs described fictional nested YAML groups (loop:,network:,optimizer:,inference:) underestimator:. These keys are not validFlow.__init__arguments and would raiseTypeErrorat runtime. All examples now use the correct flat format matching the actual working examples inexamples/.Class name
Gaussian→GaussianFullCov(multiple files): The classGaussianwas never defined or exported — onlyGaussianFullCovexists ingaussian_fullcov.py.from falcon.estimators import Gaussianwould raiseAttributeError.DiagonalWhitenerYAML example (docs/api/embeddings.md): Missing requireddimargument — would raiseTypeErroron instantiation.Parameter name fixes
scheduler_patience→lr_patience(actualFlow/GaussianFullCovparam)use_best_models_during_inference→use_best_modelsloss/train→train:loss,loss/val→val:loss,best_val_loss→checkpoint:conditional/checkpoint:marginalbuffer.max_epochs(nonexistent) →buffer.max_samplesin CLI override exampleInstallation / CLI fixes
pip install -e ".[monitor]"→".[all]"in README ([monitor]extra never existed)pip install -e .→".[all]"indocs/index.md(bare install lackssbi, whichFlowrequires)paths.import→paths.imports(correct key name, list type)Python 3.9+→Python 3.10+(matchespyproject.toml)falcon monitorfrom CLI table (doesn't exist; TUI launches automatically infalcon launch)ppdtofalcon samplesynopsisMissing / incomplete API docs
setup()added toBaseEstimatormembers list (it is@abstractmethod)add_node()added toGraphmembers list (main Python API for programmatic graph construction)FlowConfig,NetworkConfig,OptimizerConfig,InferenceConfigclass references fromflow.mdFlowparameters:prior_epochs,betas,devicesimulate_chunk_size,initial_samples_pathlognormaldistribution: noted it only works withmode="standard_normal"(raisesValueErrorwithmode="hypercube")api/index.md:gaussian_fullcov,stepwise_base,networks,embedded_posteriorGaussianFullCovclass reference path (gaussian_fullcovmodule, notgaussian)Test plan
docs/getting-started.mdanddocs/configuration.mdrun without error againstexamples/01_minimalfrom falcon.estimators import GaussianFullCovsucceedsfalcon sample ppdis accepted by the CLI🤖 Generated with Claude Code