[DOCS] Update docs to note that pred_contrib is not available for linear trees #4006
Conversation
btrotta
requested review from
chivee,
guolinke,
jameslamb,
Laurae2 and
StrikerRUS
as code owners
btrotta
changed the title
There was a problem hiding this comment.
@btrotta could you add a warning in code, preferably at the C++ level? For other frameworks that LightGBM models are used with, there might not be any manual review of the pred_contrib output, and that might mean that wrong values are just silently used. I think raising a warning would be helpful, because then at least there is a chance of it being noticed in logs.
src/application/predictor.hpp
Outdated
| @@ -85,6 +85,10 @@ class Predictor { | |||
| } | |||
| }; | |||
| } else if (predict_contrib) { | |||
| if (boosting_->IsLinear()) { | |||
| Log::Warning("Predicting SHAP feature contributions is not implemented for linear trees. " | |||
There was a problem hiding this comment.
Maybe raising error will be better? I believe it is better than returning nonsense results.
| Log::Warning("Predicting SHAP feature contributions is not implemented for linear trees. " | |
| Log::Fatal("Predicting SHAP feature contributions is not implemented for linear trees. " |
|
This pull request has been automatically locked since there has not been any recent activity since it was closed. To start a new related discussion, open a new issue at https://github.com/microsoft/LightGBM/issues including a reference to this. |
As noted in #4002,
pred_contribdoes not work for linear trees.