Repository navigation
v2: a shorter README for users - #163
Merged
Merged
Conversation
…etails in examples/
…own path, marginals, processors, summary fills, held latents
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.
The README was a 778-line reference manual. It is now 364 lines, ordered by what a user needs first, and points to
examples/for the details.Structure:
#write-your-own-tableslink.SchemaPrior, saved for relbench, plus the corpus command;realizeversussample), random tables and databases, save and inspect, reproducibility.What moved out: the detailed reference now links to the runnable scripts in
examples/concepts/instead of sitting inline: latent versus recorded values, how foreign-key options combine, count and fill rules, calibration details,Scaledshapes, save semantics and the low-level graph. Dropped as no longer useful to users: the migration note for earlier unreleased v2 commits, and "Go lower", which pointed at internal classes.The anchors that other files link to (
#build-a-table,#author-many-tables-from-one-description) are kept, and every relative link resolves.pixi run examplespasses: 9 blocks run together and 3 also run on their own.