fix: refactoring codes

jina-ai · May 6, 2020 · c4fe17d · c4fe17d
1 parent 0048f34
commit c4fe17d
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/jina/executors/encoders/__init__.py b/jina/executors/encoders/__init__.py
@@ -89,6 +89,9 @@ class BaseCVPaddlehubEncoder(BasePaddleExecutor, BaseNumericEncoder):
     """
     :class:`BaseCVPaddlehubEncoder` implements the common parts for :class:`ImagePaddlehubEncoder` and
         :class:`VideoPaddlehubEncoder`.
+
+    ..warning::
+        :class:`BaseCVPaddlehubEncoder`  is not intented to be used to do the real encoding.
     """
     def __init__(self,
                  model_name: str,
@@ -144,6 +147,12 @@ def close(self):
 
 
 class BaseTorchEncoder(BaseTorchExecutor):
+    """"
+    :class:`BaseTorchEncoder` implements the common part for :class:`ImageTorchEncoder` and :class:`VideoTorchEncoder`.
+
+    ..warning::
+        :class:`BaseTorchEncoder`  is not intented to be used to do the real encoding.
+    """
     def __init__(self,
                  model_name: str,
                  channel_axis: int = 1,