Skip to content

Commit 38f7916

Browse files
committed
Adding documentation for __init__.py
1 parent 82d8282 commit 38f7916

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

arrayfire/__init__.py

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,34 @@
77
# http://arrayfire.com/licenses/BSD-3-Clause
88
########################################################
99

10+
"""
11+
A high performance scientific computing library for CUDA, OpenCL and CPU devices.
12+
13+
The functionality provided by ArrayFire spans the following domains:
14+
15+
1. Vector Algorithms
16+
2. Image Processing
17+
3. Signal Processing
18+
4. Computer Vision
19+
5. Linear Algebra
20+
6. Statistics
21+
22+
Programs written using ArrayFire are portable across CUDA, OpenCL and CPU devices
23+
24+
The default backend is chosen in the following order of preference based on the available libraries:
25+
26+
1. CUDA
27+
2. OpenCL
28+
3. CPU
29+
30+
The backend can be chosen at the beginning of the program by using the following function
31+
32+
>>> af.backend.set(name)
33+
34+
where name is one of 'cuda', 'opencl' or 'cpu'
35+
36+
"""
37+
1038
from .library import *
1139
from .array import *
1240
from .data import *

0 commit comments

Comments
 (0)