Merge pull request #90 from y-takashina/develop

Develop
ytakashina · Oct 2, 2018 · aae48fc · aae48fc
2 parents cf95370 + 8f41286
commit aae48fc
Showing 1 changed file with 8 additions and 4 deletions.
diff --git a/depynd/information/_information.py b/depynd/information/_information.py
@@ -14,10 +14,12 @@ def mutual_information(X, Y, mi_estimator='auto', is_discrete='auto', force_non_
     Y : array-like, shape (n_samples, n_features_y) or (n_samples)
         Observations of the other variable.
     mi_estimator : {'knn', 'dr', 'plugin', 'auto'}, default 'auto'
-        MI estimator.
+        MI estimator. If 'auto', MI estimator will be selected depending on whether all features are purely discrete,
+        purely continuous, or discrete-continuous mixed. If purely discrete, 'plugin' estimator will be used. If purely
+        continuous, 'dr' estimator will be chosen. Otherwise, 'knn' estimator will be selected.
     is_discrete : {'auto', bool}, default 'auto'
         If ``bool``, then it determines whether to consider all features purely discrete or purely continuous. If
-        ``'auto'``, a column which contains duplicate elements will be considered as discrete.
+        'auto', a column which contains duplicate elements will be considered discrete.
     force_non_negative : bool, default False
         If ``True``, the result will be taken max with zero.
     kwargs : dict
@@ -91,10 +93,12 @@ def conditional_mutual_information(X, Y, Z, mi_estimator='auto', is_discrete='au
     Z : array-like, shape (n_samples, n_features_z) or (n_samples)
         Observations of the conditioning variable.
     mi_estimator : {'knn', 'dr', 'plugin', 'auto'}, default 'auto'
-        MI estimator.
+        MI estimator. If 'auto', MI estimator will be selected depending on whether all features are purely discrete,
+        purely continuous, or discrete-continuous mixed. If purely discrete, 'plugin' estimator will be used. If purely
+        continuous, 'dr' estimator will be chosen. Otherwise, 'knn' estimator will be selected.
     is_discrete : {'auto', bool}, default 'auto'
         If ``bool``, then it determines whether to consider all features purely discrete or purely continuous. If
-        ``'auto'``, a column which contains duplicate elements will be considered as discrete.
+        'auto', a column which contains duplicate elements will be considered discrete.
     force_non_negative : bool, default False
         If ``True``, the result will be taken max with zero.
     kwargs : dict, default None