Improve documentation of ExternalSource and RandomResizedCrop (#815)

Signed-off-by: Joaquin Anton <janton@nvidia.com>
NVIDIA · Apr 24, 2019 · 01d024a · 01d024a
1 parent 0d307ca
commit 01d024a
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 4 deletions.
diff --git a/dali/pipeline/operators/resize/random_resized_crop.cc b/dali/pipeline/operators/resize/random_resized_crop.cc
@@ -24,7 +24,8 @@ namespace dali {
 
 DALI_SCHEMA(RandomResizedCrop)
   .DocStr("Perform a crop with randomly chosen area and aspect ratio,"
-      " then resize it to given size.")
+" then resize it to given size. Expects a 3-dimensional input with samples"
+" in HWC layout (height, width, channels)")
   .NumInput(1)
   .NumOutput(1)
   .AllowMultipleInputSets()

diff --git a/dali/pipeline/operators/util/external_source.cc b/dali/pipeline/operators/util/external_source.cc
@@ -45,8 +45,10 @@ DALI_REGISTER_OPERATOR(ExternalSource, ExternalSource<CPUBackend>, CPU);
 DALI_SCHEMA(ExternalSource)
   .DocStr(R"code(Allows externally provided data to be passed as an input to the pipeline,
 see :meth:`nvidia.dali.pipeline.Pipeline.feed_input` and
-:meth:`nvidia.dali.pipeline.Pipeline.iter_setup`. Currenlty this operator is not
-supported in TensorFlow.)code")
+:meth:`nvidia.dali.pipeline.Pipeline.iter_setup`. Currently this operator is not
+supported in TensorFlow. It is worth noting that fed inputs should match the number of dimensions
+expected by the next operator in the pipeline (e.g. NHWC will expect 3-dimensional tensors
+where the last dimension represents the different channels).)code")
   .NumInput(0)
   .NumOutput(1);
 

diff --git a/dali/python/nvidia/dali/pipeline.py b/dali/python/nvidia/dali/pipeline.py
@@ -232,7 +232,8 @@ def build(self):
 
     def feed_input(self, ref, data):
         """Bind the NumPy array to a tensor produced by ExternalSource
-        operator."""
+        operator. It is worth mentioning that `ref` should not be overriden
+        with other operator outputs."""
         if not self._built:
             raise RuntimeError("Pipeline must be built first.")
         if not isinstance(ref, Edge.EdgeReference):