Class HdbscanOptions

java.lang.Object
org.tribuo.clustering.hdbscan.HdbscanOptions
All Implemented Interfaces:
com.oracle.labs.mlrg.olcut.config.Options

public final class HdbscanOptions extends Object implements com.oracle.labs.mlrg.olcut.config.Options
OLCUT Options for the HDBSCAN* implementation.
  • Field Details

    • minClusterSize

      @Option(longName="minimum-cluster-size", usage="The minimum number of points required to form a cluster.") public int minClusterSize
      The minimum number of points required to form a cluster. Defaults to 5.
    • distanceType

      @Option(longName="distance-function", usage="Distance function to use for various distance calculations.") public HdbscanTrainer.Distance distanceType
      Distance function in HDBSCAN*. Defaults to EUCLIDEAN.
    • k

      @Option(longName="k-nearest-neighbors", usage="The number of nearest-neighbors to use in the initial density approximation. The value includes the point itself.") public int k
      The number of nearest-neighbors to use in the initial density approximation. Defaults to 5.
    • numThreads

      @Option(longName="hdbscan-num-threads", usage="Number of threads to use for training the hdbscan model.") public int numThreads
      Number of threads to use for training the hdbscan model. Defaults to 2.
  • Constructor Details

    • HdbscanOptions

      public HdbscanOptions()
  • Method Details

    • getOptionsDescription

      public String getOptionsDescription()
      Specified by:
      getOptionsDescription in interface com.oracle.labs.mlrg.olcut.config.Options
    • getTrainer

      public HdbscanTrainer getTrainer()
      Gets the configured HdbscanTrainer using the options in this object.
      Returns:
      A HdbscanTrainer.