search

algorithmfoundry / Foundry

The Cognitive Foundry is an open-source Java library for building intelligent systems using machine learning
Other
131 stars 41 forks source link

Improvement in API/documentation clarity with regards to "maximum minimum distance" #42

Closed Zero3 closed 9 years ago

Zero3 commented 9 years ago

I have a small suggestion for improvement of clarity in the API/documentation for the AgglomerativeClusterer class: Rename "maximum minimum distance" to "maximum distance".

For example:

public void setMaxMinDistance(double maxMinDistance)

The maximum minimum distance between clusters that is allowed for the two clusters to be merged. If there are no clusters that remain that have a distance between them less than or equal to this value, then the clustering will halt. To not have this value factored into the clustering, set it to something such as Double.MAX_VALUE.

jbasilico commented 9 years ago

Yeah, that is a bit confusing. I'll update it and mark the previous version as deprecated.