Package smile.clustering

Record Class SpectralClustering.Options

java.lang.Object
java.lang.Record
smile.clustering.SpectralClustering.Options
Record Components:
k - the number of clusters.
l - the number of random samples for Nystrom approximation. Uses 0 to disable approximation.
sigma - the smooth/width parameter of Gaussian kernel, which is a somewhat sensitive parameter. To search for the best setting, one may pick the value that gives the tightest clusters (smallest distortion) in feature space.
maxIter - the maximum number of iterations.
tol - the tolerance of convergence test.
controller - the optional training controller.
Enclosing class:
SpectralClustering
public static record SpectralClustering.Options(int k, int l, double sigma, int maxIter, double tol, IterativeAlgorithmController<AlgoStatus> controller) extends Record
Spectral clustering hyperparameters.

  • Constructor Details

    • Options

      public Options(int k, int l, double sigma, int maxIter, double tol, IterativeAlgorithmController<AlgoStatus> controller)
      Constructor.

    • Options

      public Options(int k, double sigma, int maxIter)
      Constructor.
      Parameters:
      k - the number of clusters.
      sigma - the smooth/width parameter of Gaussian kernel.
      maxIter - the maximum number of iterations.

    • Options

      public Options(int k, int l, double sigma, int maxIter)
      Constructor.
      Parameters:
      k - the number of clusters.
      l - the number of random samples for Nystrom approximation. Uses 0 to disable approximation.
      sigma - the smooth/width parameter of Gaussian kernel.
      maxIter - the maximum number of iterations.

  • Method Details

    • toProperties

      public Properties toProperties()
      Returns the persistent set of hyperparameters.
      Returns:
      the persistent set.

    • of

      public static SpectralClustering.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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      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.

    • k

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

    • l

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

    • sigma

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

    • maxIter

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

    • tol

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

    • controller

      public IterativeAlgorithmController<AlgoStatus> controller()
      Returns the value of the controller record component.
      Returns:
      the value of the controller record component