Merge pull request #113 from Yoctol/import-sugar

add import sugar for Pipe, modify its docstring
Yoctol · Apr 15, 2019 · 81223b1 · 81223b1
2 parents 7ec7062 + b3d731e
commit 81223b1
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 4 deletions.
diff --git a/uttut/pipeline/__init__.py b/uttut/pipeline/__init__.py
@@ -1 +1,2 @@
 from . import ops
+from .pipe import Pipe
diff --git a/uttut/pipeline/pipe.py b/uttut/pipeline/pipe.py
@@ -12,11 +12,12 @@
 
 class Pipe:
 
-    """Pipe is a container for a series of operators
+    """Pipe is a container for a series of operators.
 
-    Attributes:
-        _steps (Operators) : a list of operator instances
-        _checkpoints (strs): a list of checkpoints
+    Properties:
+        steps: a list of operator instances.
+        checkpoints: a mapping of checkpoints to index of steps.
+        output_type: type of transformed output.
     """
 
     def __init__(self):