Record Class KernelSHAP.Options

java.lang.Object
java.lang.Record
smile.feature.importance.KernelSHAP.Options
Record Components:
numSamples - maximum number of coalitions to evaluate per instance (0 = auto: 2 * M + 2048).
ridge - L2 regularization parameter for numerical stability (default 1e-8).
All Implemented Interfaces:
Serializable
Enclosing class:
KernelSHAP<T>
public static record KernelSHAP.Options(int numSamples, double ridge) extends Record implements Serializable
KernelSHAP hyperparameters.
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    Options()
    Default constructor with auto sample budget and 1e-8 ridge penalty.
    Options(int numSamples)
    Constructor with custom sample budget and default ridge penalty.
    Options(int numSamples, double ridge)
    Validates options.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    int
    numSamples()
    Returns the value of the numSamples record component.
    static KernelSHAP.Options
    of(Properties props)
    Returns the options from properties.
    double
    ridge()
    Returns the value of the ridge record component.
    Properties
    toProperties()
    Returns the persistent set of hyperparameters including smile.shap.samples smile.shap.ridge
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • Options

      public Options(int numSamples, double ridge)
      Validates options.

    • Options

      public Options()
      Default constructor with auto sample budget and 1e-8 ridge penalty.

    • Options

      public Options(int numSamples)
      Constructor with custom sample budget and default ridge penalty.
      Parameters:
      numSamples - maximum number of coalitions to evaluate per instance.

  • Method Details

    • toProperties

      public Properties toProperties()
      Returns the persistent set of hyperparameters including
      • smile.shap.samples
      • smile.shap.ridge
      Returns:
      the persistent properties.

    • of

      public static KernelSHAP.Options of(Properties props)
      Returns the options from properties.
      Parameters:
      props - the hyperparameters.
      Returns:
      the options.

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with the compare method from their corresponding wrapper classes.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • numSamples

      public int numSamples()
      Returns the value of the numSamples record component.
      Returns:
      the value of the numSamples record component

    • ridge

      public double ridge()
      Returns the value of the ridge record component.
      Returns:
      the value of the ridge record component