diff options
author | Rémi Flamary <remi.flamary@gmail.com> | 2018-06-11 13:00:57 +0200 |
---|---|---|
committer | Rémi Flamary <remi.flamary@gmail.com> | 2018-06-11 13:00:57 +0200 |
commit | ecb093b95ddbeaeb800b443d3a5c9d5c24c5897c (patch) | |
tree | 7d6f87bbbe776b7194a8fd1469094d1ce9506f97 /ot/smooth.py | |
parent | de4f7ba6fa75eac92621fba51c11bf56153603cf (diff) |
ad documentation class Regularization
Diffstat (limited to 'ot/smooth.py')
-rw-r--r-- | ot/smooth.py | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/ot/smooth.py b/ot/smooth.py index 87d61ef..5a8e4b5 100644 --- a/ot/smooth.py +++ b/ot/smooth.py @@ -75,6 +75,13 @@ def projection_simplex(V, z=1, axis=None): class Regularization(object): + """Base class for Regularization objects + + Notes + ----- + This class is not intended for direct use but as aparent for true + regularizatiojn implementation. + """ def __init__(self, gamma=1.0): """ |