Skip to content

Commit 745f501

Browse files
committed
update readme
1 parent 695180e commit 745f501

File tree

1 file changed

+4
-8
lines changed

1 file changed

+4
-8
lines changed

README.md

+4-8
Original file line numberDiff line numberDiff line change
@@ -27,18 +27,14 @@ pip install graph-based-clustering
2727

2828
### Usage
2929

30-
**graph-based-clustering** has two clustering methods:
31-
- ConnectedComponentsClustering
32-
- SpanTreeConnectedComponentsClustering
33-
34-
Both of these methods has sklearn-like `fit/fit_predict` interface.
30+
The library has sklearn-like `fit/fit_predict` interface.
3531

3632
#### ConnectedComponentsClustering
3733

38-
This method makes pairwise distances matrix on the input data, uses *threshold* (parameter given by the user) to binarize pairwise distances matrix and make undirected graph, and then finds connected components to perform the clustering.
34+
This method computes pairwise distances matrix on the input data, and using *threshold* (parameter provided by the user) to binarize pairwise distances matrix makes an undirected graph in order to find connected components to perform the clustering.
3935

4036
Required arguments:
41-
- **threshold** - threshold to binarize pairwise distances matrix and make undirected graph
37+
- **threshold** - paremeter to binarize pairwise distances matrix and make undirected graph
4238

4339
Optional arguments:
4440
- **metric** - sklearn.metrics.[pairwise_distances](https://scikit-learn.org/stable/modules/generated/sklearn.metrics.pairwise_distances.html) parameter (default: *"euclidean"*)
@@ -67,7 +63,7 @@ labels_pred = clustering.fit_predict(X)
6763

6864
#### SpanTreeConnectedComponentsClustering
6965

70-
This method makes pairwise distances matrix on the input data, consider this matrix as a graph, finds minimum spanning trees, and finaly, to perform the clustering, makes graph with *n_clusters* (parameter given by the user) connected components by removing *n_clusters - 1* edges with highest weights.
66+
This method computes pairwise distances matrix on the input data, builds a graph on the obtained matrix, finds minimum spanning tree, and finaly, performs the clustering through dividing the graph into *n_clusters* (parameter given by the user) by removing *n-1* edges with the highest weights.
7167

7268
Required arguments:
7369
- **n_clusters** - the number of clusters to find

0 commit comments

Comments
 (0)