Skip to content

Commit

Permalink
updated readme based on 0.0.6 update
Browse files Browse the repository at this point in the history
  • Loading branch information
hj-n committed Apr 15, 2023
1 parent 3c7c3de commit e9a1467
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 3 deletions.
13 changes: 11 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,8 @@ class SNC(
dist_strategy="snn",
dist_paramter={},
dist_function=None,
cluster_strategy="dbscan"
cluster_strategy="dbscan",
snn_knn_matrix=None
)
```

Expand Down Expand Up @@ -122,6 +123,7 @@ class SNC(
> - `"snn"` : utilizes Shared Nearest Neighbor based on dissimilarity
> - `"euclidean"`
> - `"predefined"` : allows user-defined distance function
> - `"inject_snn"` : inject knn and snn info
> - We highly recommend to use default distance strategy "snn".
> - If you set `dist_strategy` as "predefined", you should also explicitly pass the way to compute distance as `dist_function` parameter. THe distance for cluster automatically computed as average linkage.
>
Expand Down Expand Up @@ -153,7 +155,14 @@ class SNC(
> - `"x-means"` : based on X-Means clustering algorithm
> - `"'K'-means"` : based on K-Means clustering algorithm, where users can freely change `'K'` value by substituting it with integer number.
> - e.g., `15-means`, `20-means`, etc.

> ***`snn_knn_matrix`*** : *`dict, (optional, default: None)`*
> - If you want to inject precomputed snn and knn, use this parameter
> - To inject the parameter, you should set `dist_strategy` as `"inject_snn"`
> - The dictionary should hold:
> - `"raw_snn"` : *`Array, shape=(n_samples, n_samples), dtype=float`*, the snn matrix of raw data
> - `"raw_knn"` : *`Array, shape=(n_samples, n_samples), dtype=float`*, the knn matrix of raw data
> - `"emb_snn"` : *`Array, shape=(n_samples, n_samples), dtype=float`*, the snn matrix of embedded data
> - `"emb_knn"` : *`Array, shape=(n_samples, n_samples), dtype=float`*, the knn matrix of embedded data

### Methods

Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

setuptools.setup(
name="snc",
version="0.0.5",
version="0.0.6",
author="Hyeon Jeon",
author_email="[email protected]",
description="Implementation of Steadiness & Cohesiveness",
Expand Down

0 comments on commit e9a1467

Please sign in to comment.