Add author method in comments

This commit is contained in:
2021-06-04 18:12:13 +02:00
parent 7677aaf94b
commit 59c86b8e53

View File

@@ -51,6 +51,9 @@ class Metrics:
def _compute_mi_cc(x, y, n_neighbors): def _compute_mi_cc(x, y, n_neighbors):
"""Compute mutual information between two continuous variables. """Compute mutual information between two continuous variables.
# Author: Nikolay Mayorov <n59_ru@hotmail.com>
# License: 3-clause BSD
Parameters Parameters
---------- ----------
x, y : ndarray, shape (n_samples,) x, y : ndarray, shape (n_samples,)
@@ -68,10 +71,10 @@ class Metrics:
Notes Notes
----- -----
True mutual information can't be negative. If its estimate by a numerical True mutual information can't be negative. If its estimate by a
method is negative, it means (providing the method is adequate) that the numerical method is negative, it means (providing the method is
mutual information is close to 0 and replacing it by 0 is a reasonable adequate) that the mutual information is close to 0 and replacing it by
strategy. 0 is a reasonable strategy.
References References
---------- ----------