Add comments to the purity_score function

Mathias
1 parent aeff19f951
Showing 1 changed file with 9 additions and 0 deletions Side-by-side Diff
volia/measures.py
@@ -152,6 +152,15 @@
  
  
 def purity_score(y_truth, y_hat):
+    '''
+    Return three values in a dictionary:
+        - purity_class_score: the purity score of the class (asp)
+        - purity_cluster_score: the purity score of the cluster (acp)
+        - K: the overall evaluation criterion (sqrt(asp * acp))
+
+    This function is based on the following article: 
+    Unknown-multiple speaker clustering using HMM, J. Ajmera, H. Bourlard, I. Lapidot, I. McCowan
+    '''
  
     def divide_line(a, divider):
         '''
...	...	@@ -152,6 +152,15 @@
152	152
153	153
154	154	def purity_score(y_truth, y_hat):
	155	+ '''
	156	+ Return three values in a dictionary:
	157	+ - purity_class_score: the purity score of the class (asp)
	158	+ - purity_cluster_score: the purity score of the cluster (acp)
	159	+ - K: the overall evaluation criterion (sqrt(asp * acp))
	160	+
	161	+ This function is based on the following article:
	162	+ Unknown-multiple speaker clustering using HMM, J. Ajmera, H. Bourlard, I. Lapidot, I. McCowan
	163	+ '''
155	164
156	165	def divide_line(a, divider):
157	166	'''