ad documentation class Regularization

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):
         """