docs: credit the R prior art this package descends from - #190
Merged
Conversation
The README had 21 headings and none of them acknowledged the R repositories that did this work first. paper.md's State of the field compares against Python libraries only, so nothing in the project pointed at the actual lineage: a reviewer reading it would see a state-of-the-field gap. Adds `### Prior art` under Research, crediting michaelpawlus/pg_donors (2015), michaelpawlus/fundraising_analytics (2016), and crazybilly/fundRaising (2021), and matching each to the estimators that cover the same ground: - pg_donors: caret classifier for planned-giving prospects with median imputation of household income. PlannedGivingIntentScorer is its descendant; WealthScreeningImputer is where that imputation became leakage-safe. - fundraising_analytics: RFM scoring, annual-giving propensity, class-imbalance correction, portfolio management. RFMTransformer, DonorPropensityModel, MovesManagementClassifier. - fundRaising: fy/fy_quarters/fydaynum, lapsed flags, giving cuts. FiscalYearTransformer, LapsePredictor. The section states plainly that the modelling is not the contribution; the packaging as check_estimator-compliant estimators with a leakage contract is.
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.
What
Adds a
### Prior artsection toREADME.md, under Research.Why
The README has 21 headings and none of them acknowledged the R repositories that
did this work first.
paper.md's State of the field compares against Pythonlibraries only (
feature-engine,mlxtend,sktime,pymc-marketing, MAPIE,crepes,scikit-uplift), so nothing anywhere in the project pointed at theactual lineage. That reads as a state-of-the-field gap, and it is also just
uncredited.
What it says
michaelpawlus/pg_donors(R, 2015)caretclassifier for planned-giving prospects; imputes missing median household income to the column median before fittingPlannedGivingIntentScorer, with the imputation moved intoWealthScreeningImputerwhere the fill value is frozen atfitmichaelpawlus/fundraising_analytics(R, 2016)RFMTransformer,DonorPropensityModel,MovesManagementClassifiercrazybilly/fundRaising(R, 2021)fy,fy_quarters,fydaynum, lapsed-donor flags, giving-level cuts, consecutive-giving runsFiscalYearTransformer,LapsePredictorThe section states plainly that the modelling is not this package's contribution.
The contribution is packaging the sector's steps as
check_estimator-compliant,composable estimators with an explicit leakage contract, in the language the rest
of the ML stack is written in.
Every repository, date, language, and file referenced was checked against the
GitHub API rather than recalled.
Checks
pytest tests/test_doc_examples.py tests/test_documented_contracts.py— 22 passedCHANGELOG.mdupdated under## [Unreleased]; author already listed inCONTRIBUTORS.mdDocs only; no source or test files touched.