Improve uplift_at_k validation and add top-k markers to prediction plots#224
Closed
RiukaRin wants to merge 10 commits into
Closed
Improve uplift_at_k validation and add top-k markers to prediction plots#224RiukaRin wants to merge 10 commits into
RiukaRin wants to merge 10 commits into
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.
This PR improves metric robustness and visualization usability in three related areas:
Added explicit validation in uplift_at_k(..., strategy="overall") to ensure the selected top-k slice contains both treatment and control samples.
Previously, this edge case could return nan
Now it raises a clear ValueError with guidance
Extended plot_uplift_preds with a new optional k parameter
Supports k as float in (0, 1) or int in [1, n_samples].
Draws top-k threshold markers (vertical lines) for treatment, control, and uplift histograms.
Adds validation for invalid k values/types.
Tightened metric tests by replacing broad pytest.raises(Exception) with explicit pytest.raises(ValueError) where appropriate.
Also updated API docs for plot_uplift_preds to mention top-k threshold markers.
Verification Process
Validated syntax of updated files via Python compile checks (py_compile)
Ran direct runtime checks for new uplift_at_k behavior:
Added/updated tests:
New test for uplift_at_k empty-group edge case
New/updated tests for plot_uplift_preds(k=...), including invalid k cases
Updated exception-type assertions in metric tests to specific ValueError
Note: full pytest run is pending in a project-compatible environment (not available in the current environment due to pytest/scikit-learn setup mismatch for full test execution)
Additional info
This PR is intentionally structured as three logical commits: