Add 'less' docstring to tensor backends

For NumPy, TensorFlow, and PyTorch

Author: matthewfeickert

src/pyhf/tensor/numpy_backend.py

@@ -61,6 +61,25 @@ def conditional(self, predicate, true_callable, false_callable):
         return true_callable() if predicate else false_callable()
 
     def less(self, tensor_in_1, tensor_in_2):
+        """
+        The boolean value of :code:`(tensor_in_1 < tensor_in_2)` element-wise
+
+        Example:
+
+            >>> import pyhf
+            >>> pyhf.set_backend(pyhf.tensor.numpy_backend())
+            >>> a = pyhf.tensorlib.astensor([4])
+            >>> b = pyhf.tensorlib.astensor([5])
+            >>> pyhf.tensorlib.less(a, b)
+            array([ True])
+
+        Args:
+            tensor_in_1 (`Tensor`): The first tensor
+            tensor_in_2 (`Tensor`): The tensor of same type as :code:`tensor_in_1`
+
+        Returns:
+            NumPy ndarray: The bool of the comparison
+        """
         tensor_in_1 = self.astensor(tensor_in_1)
         tensor_in_2 = self.astensor(tensor_in_2)
         return np.less(tensor_in_1, tensor_in_2)

src/pyhf/tensor/pytorch_backend.py

@@ -61,6 +61,25 @@ def conditional(self, predicate, true_callable, false_callable):
         return true_callable() if predicate else false_callable()
 
     def less(self, tensor_in_1, tensor_in_2):
+        """
+        The boolean value of :code:`(tensor_in_1 < tensor_in_2)` element-wise
+
+        Example:
+
+            >>> import pyhf
+            >>> pyhf.set_backend(pyhf.tensor.pytorch_backend())
+            >>> a = pyhf.tensorlib.astensor([4])
+            >>> b = pyhf.tensorlib.astensor([5])
+            >>> pyhf.tensorlib.less(a, b)
+            tensor([True])
+
+        Args:
+            tensor_in_1 (`Tensor`): The first tensor
+            tensor_in_2 (`Tensor`): The tensor of same type as :code:`tensor_in_1`
+
+        Returns:
+            PyTorch Tensor: The bool of the comparison
+        """
         tensor_in_1 = self.astensor(tensor_in_1)
         tensor_in_2 = self.astensor(tensor_in_2)
         return torch.lt(tensor_in_1, tensor_in_2)

src/pyhf/tensor/tensorflow_backend.py

@@ -77,6 +77,30 @@ def conditional(self, predicate, true_callable, false_callable):
         return tf.cond(predicate, true_callable, false_callable)
 
     def less(self, tensor_in_1, tensor_in_2):
+        """
+        The boolean value of :code:`(tensor_in_1 < tensor_in_2)` element-wise
+
+        Example:
+
+            >>> import pyhf
+            >>> import tensorflow as tf
+            >>> sess = tf.Session()
+            ...
+            >>> pyhf.set_backend(pyhf.tensor.tensorflow_backend(session=sess))
+            >>> a = pyhf.tensorlib.astensor([4])
+            >>> b = pyhf.tensorlib.astensor([5])
+            >>> with sess.as_default():
+            ...   sess.run(pyhf.tensorlib.less(a, b))
+            ...
+            array([ True])
+
+        Args:
+            tensor_in_1 (`Tensor`): The first tensor
+            tensor_in_2 (`Tensor`): The tensor of same type as :code:`tensor_in_1`
+
+        Returns:
+            TensorFlow Tensor: The bool of the comparison
+        """
         tensor_in_1 = self.astensor(tensor_in_1)
         tensor_in_2 = self.astensor(tensor_in_2)
         return tf.math.less(tensor_in_1, tensor_in_2)