add Evidence based clustering combination (EAC)

marrygit · Aug 6, 2019 · a8a1be6 · a8a1be6
1 parent 2f576b0
commit a8a1be6
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 2 deletions.
diff --git a/README.rst b/README.rst
@@ -382,7 +382,8 @@ Example of Clustering Combination
 
 
 `"examples/cluster_comb_example.py" <https://github.com/yzhao062/combo/blob/master/examples/cluster_comb_example.py>`_
-demonstrates the basic API of combining multiple base clustering estimators.
+demonstrates the basic API of combining multiple base clustering estimators. `"examples/cluster_eac_example.py" <https://github.com/yzhao062/combo/blob/master/examples/cluster_eac_example.py>`_
+demonstrates the basic API of Combining multiple clusterings using evidence accumulation (EAC).
 
 #. Initialize a group of clustering methods as base estimators
 

diff --git a/docs/api.rst b/docs/api.rst
@@ -26,6 +26,7 @@ Cluster Combination
 
 * :class:`combo.models.cluster_comb.ClustererEnsemble`: Clusterer Ensemble combines multiple base clustering estimators by alignment.
 * :func:`combo.models.cluster_comb.clusterer_ensemble_scores`: Clusterer Ensemble on clustering results directly.
+* :class:`combo.models.cluster_eac.EAC`: Combining multiple clusterings using evidence accumulation (EAC).
 
 
 ----

diff --git a/docs/combo.models.rst b/docs/combo.models.rst
@@ -47,6 +47,15 @@ combo.models.cluster\_comb module
    :show-inheritance:
    :inherited-members:
 
+combo.models.cluster\_eac module
+--------------------------------
+
+.. automodule:: combo.models.eac
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :inherited-members:
+
 combo.models.detector\_comb module
 ----------------------------------
 

diff --git a/docs/example.rst b/docs/example.rst
@@ -127,7 +127,8 @@ Example of Clustering Combination
 
 
 `"examples/cluster_comb_example.py" <https://github.com/yzhao062/combo/blob/master/examples/cluster_comb_example.py>`_
-demonstrates the basic API of combining multiple base clustering estimators.
+demonstrates the basic API of combining multiple base clustering estimators. `"examples/cluster_eac_example.py" <https://github.com/yzhao062/combo/blob/master/examples/cluster_eac_example.py>`_
+demonstrates the basic API of Combining multiple clusterings using evidence accumulation (EAC).
 
 #. Initialize a group of clustering methods as base estimators