feat: add tuple support and exam_cb for callbacks#665
Open
ugbotueferhire wants to merge 5 commits intointerpretml:mainfrom
Open
feat: add tuple support and exam_cb for callbacks#665ugbotueferhire wants to merge 5 commits intointerpretml:mainfrom
ugbotueferhire wants to merge 5 commits intointerpretml:mainfrom
Conversation
ugbotueferhire
force-pushed
the
feature/callback-tuples
branch
from
3c62aa9 to
5b7a76f
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #665 +/- ##
==========================================
+ Coverage 66.64% 66.94% +0.30%
==========================================
Files 76 76
Lines 11634 11704 +70
==========================================
+ Hits 7753 7835 +82
+ Misses 3881 3869 -12
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
ugbotueferhire
force-pushed
the
feature/callback-tuples
branch
from
5b7a76f to
07f9ff4
Compare
Signed-off-by: ugbotueferhire <ugbotueferhire@gmail.com>
ugbotueferhire
force-pushed
the
feature/callback-tuples
branch
from
07f9ff4 to
ca55033
Compare
Signed-off-by: ugbotueferhire <ugbotueferhire@gmail.com>
…ples # Conflicts: # python/interpret-core/interpret/glassbox/_ebm.py
…ature/callback-tuples
Contributor
Author
|
@paulbkoch conflicts has been resolved |
paulbkoch
reviewed
May 6, 2026
Comment on lines
+135
to
+142
| if len(callbacks) == 0: | ||
| msg = "callback tuple cannot be empty" | ||
| _log.error(msg) | ||
| raise ValueError(msg) | ||
| if len(callbacks) > 2: | ||
| msg = "callback tuple can contain at most one progress callback and one examination callback" | ||
| _log.error(msg) | ||
| raise ValueError(msg) |
Collaborator
There was a problem hiding this comment.
We can get rid of these checks. Empty callback tuple should be allowed and return None, None which it does in the code below already. And if callbacks has more than two values then it will be detected by the duplicate checks below.
Comment on lines
+93
to
+127
| try: | ||
| signature = inspect.signature(callback) | ||
| except (TypeError, ValueError) as exc: | ||
| msg = "callback must have an inspectable signature" | ||
| _log.error(msg) | ||
| raise ValueError(msg) from exc | ||
|
|
||
| has_metric = "metric" in signature.parameters | ||
| has_gain = "gain" in signature.parameters | ||
| if has_metric == has_gain: | ||
| msg = ( | ||
| "callback must accept either the progress signature " | ||
| "(*, bag, stage, step, term, metric) or the examination signature " | ||
| "(*, bag, stage, step, term, gain)" | ||
| ) | ||
| _log.error(msg) | ||
| raise ValueError(msg) | ||
|
|
||
| required_names = _PROGRESS_CALLBACK_NAMES if has_metric else _EXAM_CALLBACK_NAMES | ||
| missing_names = [ | ||
| name for name in required_names if name not in signature.parameters | ||
| ] | ||
| if missing_names: | ||
| msg = f"callback is missing required parameters: {missing_names}" | ||
| _log.error(msg) | ||
| raise ValueError(msg) | ||
|
|
||
| try: | ||
| signature.bind(**{name: None for name in required_names}) | ||
| except TypeError as exc: | ||
| msg = f"callback must be callable with keyword arguments {required_names}" | ||
| _log.error(msg) | ||
| raise ValueError(msg) from exc | ||
|
|
||
| return "progress" if has_metric else "exam" |
Collaborator
There was a problem hiding this comment.
This is probably simpler and more expandable as something like:
callback_types = {"progress" : {"bag", "stage", "step", "term", "metric"}, "exam": {"bag", "stage", "step", "term", "gain"}}
param_names = set(inspect.signature(callback).parameters)
for name, params in callback_types.items():
if params == param_names:
return name
raise something
| @@ -264,6 +265,19 @@ | |||
| # penalize nominals a bit because they benefit from sorting categories | |||
| avg_gain *= gain_scale | |||
|
|
|||
Collaborator
There was a problem hiding this comment.
should check
if stop_flag is not None and stop_flag[0]:
break
here
Comment on lines
398
to
399
| if stop_flag is not None and stop_flag[0]: | ||
| break |
Collaborator
There was a problem hiding this comment.
This one can be removed since we're checking before both callbacks
| learning_rate: float = 0.02, | ||
| greedy_ratio: float | None = 10.0, | ||
| cyclic_progress: bool | float = False, | ||
| cyclic_progress: bool | float | int = False, # noqa: PYI041 |
Collaborator
There was a problem hiding this comment.
The float type hint includes int, so remove int and the noqa
| learning_rate: float = 0.015, | ||
| greedy_ratio: float | None = 10.0, | ||
| cyclic_progress: bool | float = False, | ||
| cyclic_progress: bool | float | int = False, # noqa: PYI041 |
Collaborator
There was a problem hiding this comment.
remove int since float includes the int type hint, and also remove noqa
| learning_rate: float = 0.04, | ||
| greedy_ratio: float | None = 10.0, | ||
| cyclic_progress: bool | float = False, | ||
| cyclic_progress: bool | float | int = False, # noqa: PYI041 |
Collaborator
There was a problem hiding this comment.
same as above. remove int and noqa
| (ExamRecordingCallback(), ExamRecordingCallback()), | ||
| "more than one examination callback", | ||
| ), | ||
| (tuple(), "cannot be empty"), |
Collaborator
There was a problem hiding this comment.
empty tuple should be valid as a no callbacks case
Comment on lines
+252
to
+277
| @pytest.mark.parametrize( | ||
| "interactions, message", | ||
| [ | ||
| ([(-999,)], "out of range of the features"), | ||
| ([("missing_feature",)], "not in the list of feature names"), | ||
| ([(None,)], "has unsupported type"), | ||
| ], | ||
| ) | ||
| def test_invalid_explicit_interaction_items_raise(interactions, message): | ||
| X, y, names, types = make_synthetic( | ||
| seed=42, classes=2, output_type="float", n_samples=200 | ||
| ) | ||
|
|
||
| ebm = ExplainableBoostingClassifier( | ||
| names, | ||
| types, | ||
| interactions=interactions, | ||
| outer_bags=1, | ||
| max_rounds=10, | ||
| n_jobs=1, | ||
| ) | ||
|
|
||
| with pytest.raises(ValueError, match=message): | ||
| ebm.fit(X, y) | ||
|
|
||
|
|
Collaborator
There was a problem hiding this comment.
this test seems out of scope for the callback change
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
2 participants
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.
Fixes #635 Callback tuple support and exam callback
Description
This PR implements Phase 2 of the callback redesign for EBM training.
Phase 1 changed the callback API to keyword-only arguments and ensured the
progress callback only fires on progressing boosting steps. That work was
merged in #662.
This PR builds on top of that by allowing
callbackto accept either:The supported callback signatures are:
Why
The original callback parameter was carrying more than one kind of signal.
As discussed in the review for #662, there are really two different callback
use cases:
gain was computed for it
Splitting those concepts makes the API clearer while still keeping a single
public
callbackparameter.What Changed
_ebm.pymetricvsgaincallbackto be either a callable or a tuple of callablesexam_callbackhook in_boost.pyat the point whereavg_gainis computed
TrueValidation Rules
This PR raises a
ValueErrorfor invalid callback configurations such as:Tests
Added or covered tests for:
gainvalues in the examination callbackVerified with:
Notes