Files required to generate documentation

Author: pavanky

arrayfire/__init__.py

@@ -8,18 +8,22 @@
 ########################################################
 
 """
-A high performance scientific computing library for CUDA, OpenCL and CPU devices.
+ArrayFire is a high performance scientific computing library with an easy to use API.
 
-The functionality provided by ArrayFire spans the following domains:
 
-    1. Vector Algorithms
-    2. Image Processing
-    3. Signal Processing
-    4. Computer Vision
-    5. Linear Algebra
-    6. Statistics
+    >>> # Monte Carlo estimation of pi
+    >>> def calc_pi_device(samples):
+            # Simple, array based API
+            # Generate uniformly distributed random numers
+            x = af.randu(samples)
+            y = af.randu(samples)
+            # Supports Just In Time Compilation
+            # The following line generates a single kernel
+            within_unit_circle = (x * x + y * y) < 1
+            # Intuitive function names
+            return 4 * af.count(within_unit_circle) / samples
 
-Programs written using ArrayFire are portable across CUDA, OpenCL and CPU devices
+Programs written using ArrayFire are portable across CUDA, OpenCL and CPU devices.
 
 The default backend is chosen in the following order of preference based on the available libraries:
 
@@ -31,7 +35,16 @@
 
     >>> af.backend.set(name)
 
-where name is one of 'cuda', 'opencl' or 'cpu'
+where name is one of 'cuda', 'opencl' or 'cpu'.
+
+The functionality provided by ArrayFire spans the following domains:
+
+    1. Vector Algorithms
+    2. Image Processing
+    3. Signal Processing
+    4. Computer Vision
+    5. Linear Algebra
+    6. Statistics
 
 """
 

arrayfire/algorithm.py

@@ -8,7 +8,7 @@
 ########################################################
 
 """
-Vector algorithms for ArrayFire
+Vector algorithms (sum, min, sort, etc).
 """
 
 from .library import *
@@ -283,7 +283,7 @@ def imax(a, dim=None):
 
 def accum(a, dim=0):
     """
-    Cumulative sum of an array along a specified dimension.
+    Cumulative sum of an array along a specified dimension
 
     Parameters
     ----------

arrayfire/arith.py

@@ -8,7 +8,7 @@
 ########################################################
 
 """
-Math functions for ArrayFire
+Math functions (sin, sqrt, exp, etc).
 """
 
 from .library import *

arrayfire/array.py

@@ -8,7 +8,7 @@
 ########################################################
 
 """
-arrayfire.Array class and helper functions.
+Array class and helper functions.
 """
 
 import inspect
@@ -488,7 +488,7 @@ def device_ptr(self):
         Return the device pointer exclusively held by the array.
 
         Returns
-        ------
+        --------
         ptr : int
               Contains location of the device pointer
 
@@ -508,7 +508,7 @@ def raw_ptr(self):
         Return the device pointer held by the array.
 
         Returns
-        ------
+        --------
         ptr : int
               Contains location of the device pointer
 
@@ -529,7 +529,7 @@ def offset(self):
         Return the offset, of the first element relative to the raw pointer.
 
         Returns
-        ------
+        --------
         offset : int
                  The offset in number of elements
         """
@@ -542,7 +542,7 @@ def strides(self):
         Return the distance in bytes between consecutive elements for each dimension.
 
         Returns
-        ------
+        --------
         strides : tuple
                   The strides for each dimension
         """
@@ -1078,7 +1078,7 @@ def to_ctype(self, row_major=False, return_shape=False):
         Return the data as a ctype C array after copying to host memory
 
         Parameters
-        ---------
+        -----------
 
         row_major: optional: bool. default: False.
             Specifies if a transpose needs to occur before copying to host memory.
@@ -1112,7 +1112,7 @@ def to_array(self, row_major=False, return_shape=False):
         Return the data as array.array
 
         Parameters
-        ---------
+        -----------
 
         row_major: optional: bool. default: False.
             Specifies if a transpose needs to occur before copying to host memory.
@@ -1147,7 +1147,7 @@ def to_list(self, row_major=False):
         Return the data as list
 
         Parameters
-        ---------
+        -----------
 
         row_major: optional: bool. default: False.
             Specifies if a transpose needs to occur before copying to host memory.

arrayfire/blas.py

@@ -8,7 +8,7 @@
 ########################################################
 
 """
-BLAS functions for arrayfire.
+BLAS functions (matmul, dot, etc)
 """
 
 from .library import *

arrayfire/data.py

@@ -384,7 +384,7 @@ def join(dim, first, second, third=None, fourth=None):
           An array containing the input arrays joined along the specified dimension.
 
     Examples
-    -------
+    ---------
 
     >>> import arrayfire as af
     >>> a = af.randu(2, 3)
@@ -460,7 +460,7 @@ def tile(a, d0, d1=1, d2=1, d3=1):
           An array containing the input after tiling the the specified number of times.
 
     Examples
-    -------
+    ---------
 
     >>> import arrayfire as af
     >>> a = af.randu(2, 3)
@@ -710,7 +710,7 @@ def flip(a, dim=0):
           The output after flipping `a` along `dim`.
 
     Examples
-    -------
+    ---------
 
     >>> import arrayfire as af
     >>> a = af.randu(3, 3)

arrayfire/device.py

@@ -76,7 +76,7 @@ def set_device(num):
     Change the active device to the specified id.
 
     Parameters
-    ---------
+    -----------
     num: int.
          id of the desired device.
     """
@@ -136,7 +136,7 @@ def is_dbl_supported(device=None):
     Check if double precision is supported on specified device.
 
     Parameters
-    ---------
+    -----------
     device: optional: int. default: None.
          id of the desired device.
 
@@ -155,7 +155,7 @@ def sync(device=None):
     Block until all the functions on the device have completed execution.
 
     Parameters
-    ---------
+    -----------
     device: optional: int. default: None.
          id of the desired device.
     """

arrayfire/features.py

@@ -7,7 +7,7 @@
 # http://arrayfire.com/licenses/BSD-3-Clause
 ########################################################
 """
-arrayfire.Features class
+Features class used for Computer Vision algorithms.
 """
 from .library import *
 from .array import *

arrayfire/graphics.py

@@ -8,7 +8,7 @@
 ########################################################
 
 """
-graphics functions for arrayfire
+Graphics functions (plot, image, etc).
 """
 
 from .library import *

arrayfire/image.py

@@ -8,7 +8,7 @@
 ########################################################
 
 """
-Image processing functions for arrayfire.
+Image processing functions.
 """
 
 from .library import *