Package com.datarobot.prediction
Interface ExplanationParams
-
public interface ExplanationParamsInterface for parameters of the prediction explanations.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interfaceExplanationParams.FeatureImpact<T>Interface for feature impact.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Map<String,ExplanationParams.FeatureImpact<?>>getFeatureImpact()Getter for feature impact.intgetMaxCodes()Getter for the max number of explanations to return.doublegetThresholdHigh()Getter for high threshold.doublegetThresholdLow()Getter for low threshold.Explanation.ExplanationTypegetType()Getter for the type of explanations.ExplanationParamswithFeatureImpact(Map<String,ExplanationParams.FeatureImpact<?>> featureImpact)Setter for the feature impact.ExplanationParamswithMaxCodes(int value)Setter for max codes.ExplanationParamswithThresholdHigh(double value)Setter for high threshold.ExplanationParamswithThresholdLow(double value)Setter for low threshold.ExplanationParamswithType(Explanation.ExplanationType type)Setter for the type of explanations
-
-
-
Method Detail
-
getThresholdLow
double getThresholdLow()
Getter for low threshold.- Returns:
- low threshold.
-
withThresholdLow
ExplanationParams withThresholdLow(double value)
Setter for low threshold.- Parameters:
value- low threshold.- Returns:
- instance of the params with new low threshold.
-
getThresholdHigh
double getThresholdHigh()
Getter for high threshold.- Returns:
- high threshold.
-
withThresholdHigh
ExplanationParams withThresholdHigh(double value)
Setter for high threshold.- Parameters:
value- high threshold.- Returns:
- instance of the params with new high threshold.
-
getMaxCodes
int getMaxCodes()
Getter for the max number of explanations to return.- Returns:
- max number of explanations to return.
-
withMaxCodes
ExplanationParams withMaxCodes(int value)
Setter for max codes.- Parameters:
value- max codes.- Returns:
- instance of the params with new max codes.
-
getType
Explanation.ExplanationType getType()
Getter for the type of explanations.- Returns:
- type of the explanations
-
withType
ExplanationParams withType(Explanation.ExplanationType type)
Setter for the type of explanations- Parameters:
type- type of explanations.- Returns:
- instance of the params with new type of explanations.
-
getFeatureImpact
Map<String,ExplanationParams.FeatureImpact<?>> getFeatureImpact()
Getter for feature impact.- Returns:
- feature impact.
-
withFeatureImpact
ExplanationParams withFeatureImpact(Map<String,ExplanationParams.FeatureImpact<?>> featureImpact)
Setter for the feature impact.- Parameters:
featureImpact- feature impact.- Returns:
- instance of the params with new feature impact.
-
-