Added docstrings to CudaNdarraySharedVariable

theano/sandbox/cuda/var.py

@@ -49,8 +49,30 @@ class CudaNdarrayConstant(Constant, _operators):
 CudaNdarrayType.Constant = CudaNdarrayConstant
 
 class CudaNdarraySharedVariable(SharedVariable, _operators):
+    """
+    Shared Variable interface to CUDA-allocated arrays
+    """
 
     def get_value(self, borrow=False, return_internal_type=False):
+        """
+        Return the value of this SharedVariable's internal array.
+
+        :param borrow: 
+                permit the return of internal storage, when used in conjunction with
+                ``return_internal_type=True``
+        :param return_internal_type:
+                True to return the internal ``cuda_ndarray`` instance rather than a ``numpy.ndarray``
+                (Default False)
+
+        By default ``get_value()`` copies from the GPU to a ``numpy.ndarray`` and returns that
+        host-allocated array.
+
+        ``get_value(False,True)`` will return a GPU-allocated copy of the original GPU array.
+
+        ``get_value(True,True)`` will return the original GPU-allocated array without any
+        copying.
+
+        """
         if return_internal_type: # return a cuda_ndarray
             if borrow:
                 return self.container.value