Skip to content

JuliaDynamics/ClusteringAPI.jl

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ClusteringAPI

A common interface for clustering data. The interface is composed of the abstract types:

  • ClusteringAlgorithm
  • ClusteringResult

which interplay with the functions:

  • cluster
  • cluster_number
  • cluster_labels
  • cluster_probs

To create new clustering algorithms simply create a new subtype of ClusteringAlgorithm that extends cluster so that it returns a new subtype of ClusteringResult. The result must extend cluster_number, cluster_labels and optionally cluster_probs.

Note that data input type must always be AbstractVector of vectors (anything that can have distance defined). Two helper functions each_data_point, input_data_size can help making this harmonious with matrix inputs.

For more, see the docstring of cluster.

About

Common API for clustering algorithms in Julia

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages