Package org.tribuo.clustering.kmeans

Class KMeansModel

java.lang.Object

org.tribuo.Model<ClusterID>

org.tribuo.clustering.kmeans.KMeansModel

All Implemented Interfaces:

com.oracle.labs.mlrg.olcut.provenance.Provenancable<ModelProvenance>, Serializable, ProtoSerializable<org.tribuo.protos.core.ModelProto>

public class KMeansModel
extends Model<ClusterID>

A K-Means model with a selectable distance function.

The predict method of this model assigns centres to the provided input, but it does not update the model's centroids.

The predict method is single threaded.

See:

 J. Friedman, T. Hastie, & R. Tibshirani.
 "The Elements of Statistical Learning"
 Springer 2001. PDF
 

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final int	CURRENT_VERSION	Protobuf serialization version.

Fields inherited from class org.tribuo.Model

ALL_OUTPUTS, BIAS_FEATURE, featureIDMap, generatesProbabilities, name, outputIDInfo, provenance, provenanceOutput

Fields inherited from interface org.tribuo.protos.ProtoSerializable

DESERIALIZATION_METHOD_NAME, PROVENANCE_SERIALIZER

Method Summary

Modifier and Type	Method	Description
protected KMeansModel	copy(String newName, ModelProvenance newProvenance)
static KMeansModel	deserializeFromProto(int version, String className, com.google.protobuf.Any message)	Deserialization factory.
List<List<Feature>>	getCentroids()	Returns a list of features, one per centroid.
DenseVector[]	getCentroidVectors()	Returns a copy of the centroids.
Optional<Excuse<ClusterID>>	getExcuse(Example<ClusterID> example)
Map<String,List<com.oracle.labs.mlrg.olcut.util.Pair<String,Double>>>	getTopFeatures(int n)
Prediction<ClusterID>	predict(Example<ClusterID> example)
org.tribuo.protos.core.ModelProto	serialize()

Methods inherited from class org.tribuo.Model

castModel, copy, createDataCarrier, deserialize, deserializeFromFile, deserializeFromStream, generatesProbabilities, getExcuses, getFeatureIDMap, getName, getOutputIDInfo, getProvenance, innerPredict, predict, predict, serializeToFile, serializeToStream, setName, toString, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

CURRENT_VERSION

public static final int CURRENT_VERSION

Protobuf serialization version.

See Also:

• Constant Field Values

Method Details

deserializeFromProto

public static KMeansModel deserializeFromProto(int version,
 String className,
 com.google.protobuf.Any message)
                                        throws com.google.protobuf.InvalidProtocolBufferException

Deserialization factory.

Parameters:

version - The serialized object version.

className - The class name.

message - The serialized data.

Returns:

The deserialized object.

Throws:

com.google.protobuf.InvalidProtocolBufferException - If the protobuf could not be parsed from the message.

getCentroidVectors

public DenseVector[] getCentroidVectors()

Returns a copy of the centroids.

In most cases you should prefer getCentroids() as it performs the mapping from Tribuo's internal feature ids to the externally visible feature names for you. This method provides direct access to the centroid vectors for use in downstream processing if the ids are not relevant (or are known to match).

Returns:

The centroids.

getCentroids

public List<List<Feature>> getCentroids()

Returns a list of features, one per centroid.

This should be used in preference to getCentroidVectors() as it performs the mapping from Tribuo's internal feature ids to the externally visible feature names.

Returns:

A list containing all the centroids.

predict

public Prediction<ClusterID> predict(Example<ClusterID> example)

Specified by:

predict in class Model<ClusterID>

getTopFeatures

public Map<String,List<com.oracle.labs.mlrg.olcut.util.Pair<String,Double>>> getTopFeatures(int n)

Specified by:

getTopFeatures in class Model<ClusterID>

getExcuse

public Optional<Excuse<ClusterID>> getExcuse(Example<ClusterID> example)

Specified by:

getExcuse in class Model<ClusterID>

serialize

public org.tribuo.protos.core.ModelProto serialize()

Specified by:

serialize in interface ProtoSerializable<org.tribuo.protos.core.ModelProto>

Overrides:

serialize in class Model<ClusterID>

copy

protected KMeansModel copy(String newName,
 ModelProvenance newProvenance)

Specified by:

copy in class Model<ClusterID>