From ecb093b95ddbeaeb800b443d3a5c9d5c24c5897c Mon Sep 17 00:00:00 2001
From: Rémi Flamary <remi.flamary@gmail.com>
Date: Mon, 11 Jun 2018 13:00:57 +0200
Subject: ad documentation class Regularization

---
 ot/smooth.py | 7 +++++++
 1 file changed, 7 insertions(+)

(limited to 'ot/smooth.py')

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):
         """
-- 
cgit v1.2.3