graspologic-org / graspologic

Python package for graph statistics

https://graspologic-org.github.io/graspologic/

[BUG] Inaccurracy in how to use autokmeans

ebridge2 opened this issue 3 years ago · comments

Eric Bridgeford commented 3 years ago

Expected Behavior

https://github.com/microsoft/graspologic/blob/10de2bf17b972decbab318568154af226dcd71fa/graspologic/cluster/kclust.py#L16

This line is false; higher silhouette score is better, to my knowledge? https://scikit-learn.org/stable/modules/generated/sklearn.metrics.silhouette_score.html

Actual Behavior

Documentation correctly reports how to use the package.

Jaewon Chung commented 3 years ago

Yea highest is best. Code is correct though.

Patrick Bourke commented 3 years ago

Also the docstring and default value for max_clusters are out of agreement:

https://github.com/microsoft/graspologic/blob/10de2bf17b972decbab318568154af226dcd71fa/graspologic/cluster/kclust.py#L20

https://github.com/microsoft/graspologic/blob/10de2bf17b972decbab318568154af226dcd71fa/graspologic/cluster/kclust.py#L47