docs: check whether a donor score is calibrated, by decile, on your own file

オープン
#343 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
70/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
python, scikit-learn

調査の方向性

Read docs/how-to/estimate_donor_lifetime_value.md for the held-out-year pattern and philanthropy/datasets/_panel.py for make_donor_panel. Write the new page docs/how-to/check_score_calibration.md, then add it to docs/how-to/index.md and mkdocs.yml. Done when the decile table runs without a download and mkdocs build --strict passes.

索引モデルが issue の本文から書いたものです。

説明

documentation good first issue roadmap
Goal

A user can tell whether "a score of 0.3" means about 30% of those donors give, using only scikit-learn, before they put the number in front of a gift officer.

Acceptance criteria
  • New how-to docs/how-to/check_score_calibration.md: fit DonorPropensityModel on the earlier fiscal years of a gift panel, score the last year, and compare predicted vs actual per decile with sklearn.calibration.calibration_curve(y, p, n_bins=10, strategy="quantile").
  • It shows the table, not only a plot, and says in plain words what an over- or under-confident decile means for a mailing list.
  • It shows CalibratedClassifierCV(..., method="sigmoid") as the fix and fits it on a fold the model was not trained on. The project's floor is scikit-learn 1.6, where cv="prefit" is deprecated: wrap the already-fitted model as CalibratedClassifierCV(FrozenEstimator(model), method="sigmoid") (from sklearn.frozen import FrozenEstimator).
  • It says what the library already does, so nobody calibrates twice: MajorGiftClassifier is Platt-calibrated internally over 5 folds, and the DonorPropensityModel docstring reports that an isotonic wrapper lowered the top-10% hit rate on all five KDD Cup 1998 seeds. The point of the page is checking calibration on a later year of your own file, not re-fitting it by default.
  • Runs on philanthropy.datasets.make_donor_panel so it needs no download; added to docs/how-to/index.md and mkdocs.yml; mkdocs build --strict passes.
Scope

Docs only. No new public function: scikit-learn already has calibration_curve and CalibratedClassifierCV.

Where to start
  • docs/how-to/estimate_donor_lifetime_value.md for the held-out-year pattern
  • philanthropy/datasets/_panel.py
Dependencies
  • None

Phase order is a release plan, not a rule against picking up independent work early. Comment on this issue before you start so two people don't build the same thing.

主要言語
Python
スター
11
フォーク
23
平均マージ
2日 19時間
マージ済み PR(30日)
31

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

PhilanthroPy-Project/PhilanthroPy のほかの issue

PhilanthroPy-Project/PhilanthroPy の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。