README: correct example errors and document the FlashBack CLI - #3
Merged
Conversation
Ran every code block in the README against 3.2.0 rather than reading
them. All Python blocks execute, but several factual claims around them
were wrong:
- The comparison table said FlashBackGraph has no CLI. It has had
`lzg flashback` (build, info, score, simulate, diversity, scale) all
along.
- path_count, pgen_moments, pgen_distribution and feature_mass_profile
were each labelled as belonging to only one of the two classes. Both
classes implement all four.
- The batch scoring example passed the placeholders 'seq1', 'seq2',
'seq3' in a section titled paste-and-runnable. It does not raise; it
quietly returns the -690.78 floor for all three, which reads as a real
result.
- path_count returns an exact arbitrary-precision int in 3.2.0, so
formatting it as {:.3e} discarded the precision the change was for.
- Wheels were described as CPython 3.9-3.12; 3.2.0 ships 3.9-3.13, and
linux wheels now need glibc 2.28+ or musl 1.2+.
- The test suite was described as ~505 tests; it is ~1,700.
Adds a FlashBack command line section covering build, info, simulate,
score, diversity and scale, and a p-sequence spectrum section for
pseq_analysis(), which was the headline 3.2.0 feature and appeared
nowhere in the README. States plainly that the spectrum API is Python
only and points at `lzg flashback score` for per-sequence probabilities
from the terminal.
Every command and snippet shown here was executed before being written.
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.
Every code block in the README was executed against 3.2.0 rather than read. All Python blocks run; the errors were in the claims around them.
Corrected
FlashBackGraphhas no CLIlzg flashback build/info/score/simulate/diversity/scaleall existpath_count,pgen_moments,pgen_distribution,feature_mass_profileare single-classgraph.pgen(['seq1','seq2','seq3'])in a paste-and-runnable sectionpath_countformatted{:.3e}intin 3.2.0Added
pseq_analysis(), the headline 3.2.0 feature, which appeared nowhere in the README.lzg flashback scoreoutput was checked against Pythonpgenand matches to six decimals, confirming the documented natural-log units.Note: PyPI renders the README bundled in the published sdist, so the project page there keeps showing the old text until the next release. GitHub updates immediately.