Class

com.alpine.model.pack.ml

KMeansModel

Related Doc: package ml

Permalink

case class KMeansModel(clusters: Seq[ClusterInfo], inputFeatures: Seq[ColumnDef], identifier: String = "") extends ClusteringRowModel with PFAConvertible with Product with Serializable

A model representing results of the K-Means clustering algorithm. Each cluster is a vector in a fixed dimensional space, and the transformer assigns the input row to its closest cluster using the Euclidean (L2) distance.

The clusters should all be of the same dimension, which should be equal to the number of input features.

clusters

The clusters of the model. These should have distinct names.

inputFeatures

A seq of numeric feature descriptions describing the input to the model. * @param identifier Used to identify this model when in a collection of models. Should be simple characters, so it can be used in a feature name.

Annotations
@SerialVersionUID()
Linear Supertypes
Product, Equals, PFAConvertible, ClusteringRowModel, CategoricalRowModel, RowModel, MLModel, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. KMeansModel
  2. Product
  3. Equals
  4. PFAConvertible
  5. ClusteringRowModel
  6. CategoricalRowModel
  7. RowModel
  8. MLModel
  9. Serializable
  10. Serializable
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new KMeansModel(clusters: Seq[ClusterInfo], inputFeatures: Seq[ColumnDef], identifier: String = "")

    Permalink

    clusters

    The clusters of the model. These should have distinct names.

    inputFeatures

    A seq of numeric feature descriptions describing the input to the model. * @param identifier Used to identify this model when in a collection of models. Should be simple characters, so it can be used in a feature name.

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def classLabels: Seq[String]

    Permalink

    The total set of classes that the predicted value can take on.

    The total set of classes that the predicted value can take on.

    returns

    The set of possible values for the predicted value.

    Definition Classes
    KMeansModelCategoricalRowModel
  6. def classesForLoading: Set[Class[_]]

    Permalink

    This should return a representative class from every jar that is needed to load the object during deserialization.

    This should return a representative class from every jar that is needed to load the object during deserialization.

    Default implementation returns the class of MLModel, and the class of the model implementation.

    Definition Classes
    MLModel
  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. val clusters: Seq[ClusterInfo]

    Permalink

    The clusters of the model.

    The clusters of the model. These should have distinct names.

  9. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  10. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  12. def getPFAConverter: PFAConverter

    Permalink
    Definition Classes
    KMeansModelPFAConvertible
  13. val identifier: String

    Permalink

    Used to identify this model when in a collection of models.

    Used to identify this model when in a collection of models. Should be simple characters, so it can be used in a feature name.

    returns

    identifier for the model.

    Definition Classes
    KMeansModelRowModel
  14. val inputFeatures: Seq[ColumnDef]

    Permalink

    A seq of numeric feature descriptions describing the input to the model.

    A seq of numeric feature descriptions describing the input to the model. * @param identifier Used to identify this model when in a collection of models. Should be simple characters, so it can be used in a feature name.

    Definition Classes
    KMeansModelRowModel
  15. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  16. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  17. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  18. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  19. def outputFeatures: Seq[ColumnDef]

    Permalink
    Definition Classes
    ClusteringRowModelRowModel
  20. def sqlOutputFeatures: Seq[ColumnDef]

    Permalink
    Definition Classes
    CategoricalRowModelRowModel
  21. def sqlTransformer(sqlGenerator: SQLGenerator): Some[KMeansSQLTransformer]

    Permalink
    Definition Classes
    KMeansModelClusteringRowModelRowModel
  22. def streamline(requiredOutputFeatureNames: Seq[String]): ClusteringRowModel

    Permalink

    Returns a streamlined version of this model, throwing away parts which are not required to produce the features with names in requiredOutputFeatureNames.

    Returns a streamlined version of this model, throwing away parts which are not required to produce the features with names in requiredOutputFeatureNames.

    Behaviour is undefined if requiredOutputFeatureNames is not actually a subset of outputFeatures.map(_columnName).

    The resulting model may still have more output features than those required (i.e. for ClassificationRowModel implementations which always have the same output features, or for OneHotEncodingModel whose output features naturally group together).

    requiredOutputFeatureNames

    names of the output features that the new model should produce.

    returns

    A model which has the same functionality for those output features listed, but potentially fewer input features.

    Definition Classes
    ClusteringRowModelRowModel
  23. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  24. def transformationSchema: DetailedTransformationSchema

    Permalink
    Definition Classes
    RowModel
  25. def transformer: KMeansTransformer

    Permalink
  26. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Product

Inherited from Equals

Inherited from PFAConvertible

Inherited from ClusteringRowModel

Inherited from CategoricalRowModel

Inherited from RowModel

Inherited from MLModel

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped