Repository navigation
docs: explain the four fitted parameters on the landing page - #11
Merged
Merged
Conversation
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.
Type
Related issue
None
What changed
The landing page's parameter table stopped at naming the four numbers. It now
explains them: a reading of each pair as a distribution (purchase rates as
Gamma, dropout probabilities as Beta), the derived quantities that carry
business meaning (
r/α, about 0.055 repeat purchases a week on CDNOW;a/(a+b), a 25% average chance of quitting per repeat purchase), and a densityfigure showing both averages sitting well right of the pile — the average
customer is not the typical customer. Also fixes the table's
αlabel, whichread "Gamma scale" while the mean it sits next to is
r/α, and scopes thedropout row to repeat purchases, matching the model. Version bumps to 0.2.1;
no library code changes.
How it was tested
Docs build clean with
-W(warnings as errors). Full suite unchanged andgreen: 292 passed, 1 skipped. The figure is generated from the published
parameter values analytically, no simulation.
Checks
uv run pytestuv run ruff checkuv run ruff format --checkuv run pytest --nbmake examples/)