/
arraymancer.nimble
265 lines (215 loc) · 9.67 KB
/
arraymancer.nimble
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
### Package
version = "0.5.0"
author = "Mamy André-Ratsimbazafy"
description = "A n-dimensional tensor (ndarray) library"
license = "Apache License 2.0"
### Dependencies
requires "nim >= 0.20.0",
"nimblas >= 0.2.2",
"nimlapack >= 0.1.1",
"nimcuda >= 0.1.4",
"nimcl >= 0.1.3",
"clblast",
"stb_image",
"zip",
"untar"
## Install files
srcDir = "src"
########################################################
# External libs configuration
### BLAS support
## OSX
# switch("define","openblas")
# switch("clibdir", "/usr/local/opt/openblas/lib")
# switch("cincludes", "/usr/local/opt/openblas/include")
### BLIS support
# switch("define","blis")
### MKL support
# Check the mkl switches in the test file for single-threaded and openp version
### Cuda configuration
## Pass -d:cuda to build arraymancer with cuda support
## Use the cuda switches below
## Replace /opt/cuda by your own path
## TODO: auto detection or at least check in common directories
## Note: It is import to gate compiler flags like -march=native behind Xcompiler "-Xcompiler -march=native"
template cudaSwitches() =
switch("cincludes", "/opt/cuda/include")
switch("cc", "gcc") # We trick Nim about nvcc being gcc, pending https://github.com/nim-lang/Nim/issues/6372
switch("gcc.exe", "/opt/cuda/bin/nvcc")
switch("gcc.linkerexe", "/opt/cuda/bin/nvcc")
switch("gcc.cpp.exe", "/opt/cuda/bin/nvcc")
switch("gcc.cpp.linkerexe", "/opt/cuda/bin/nvcc")
# Due to the __ldg intrinsics in kernels
# we only support compute capabilities 3.5+
# See here: http://docs.nvidia.com/cuda/pascal-compatibility-guide/index.html
# And wikipedia for GPU capabilities: https://en.wikipedia.org/wiki/CUDA
switch("gcc.options.always", "-arch=sm_61 --x cu") # Interpret .c files as .cu
switch("gcc.cpp.options.always", "-arch=sm_61 --x cu -Xcompiler -fpermissive") # Interpret .c files as .cu, gate fpermissive behind Xcompiler
switch("define", "cudnn")
when defined(cuda):
cudaSwitches
template mkl_threadedSwitches() =
switch("define","openmp")
switch("stackTrace","off")
switch("define","blas=mkl_intel_lp64")
switch("define","lapack=mkl_intel_lp64")
switch("clibdir", "/opt/intel/mkl/lib/intel64")
switch("passl", "/opt/intel/mkl/lib/intel64/libmkl_intel_lp64.a")
switch("passl", "-lmkl_core")
switch("passl", "-lmkl_gnu_thread")
switch("passl", "-lgomp")
switch("dynlibOverride","mkl_intel_lp64")
template mkl_singleSwitches() =
switch("define","blas=mkl_intel_lp64")
switch("define","lapack=mkl_intel_lp64")
switch("clibdir", "/opt/intel/mkl/lib/intel64")
switch("passl", "/opt/intel/mkl/lib/intel64/libmkl_intel_lp64.a")
switch("passl", "-lmkl_core")
switch("passl", "-lmkl_sequential")
switch("dynlibOverride","mkl_intel_lp64")
template cuda_mkl_openmp() =
mkl_threadedSwitches()
switch("cincludes", "/opt/cuda/include")
switch("cc", "gcc") # We trick Nim about nvcc being gcc, pending https://github.com/nim-lang/Nim/issues/6372
switch("gcc.exe", "/opt/cuda/bin/nvcc")
switch("gcc.linkerexe", "/opt/cuda/bin/nvcc")
switch("gcc.cpp.exe", "/opt/cuda/bin/nvcc")
switch("gcc.cpp.linkerexe", "/opt/cuda/bin/nvcc")
switch("gcc.options.always", "-arch=sm_61 --x cu -Xcompiler -fopenmp -Xcompiler -march=native")
switch("gcc.cpp.options.always", "-arch=sm_61 --x cu -Xcompiler -fopenmp -Xcompiler -march=native")
########################################################
# Optimization
# Multithreading
# use the -d:openmp switch
# which passC: -fopenmp to the compiler
# Native processor optimization
# use the -d:native
# which passC: -march=native to the compiler
##########################################################################
## Testing tasks
proc test(name: string, lang: string = "c") =
if not dirExists "build":
mkDir "build"
if not dirExists "nimcache":
mkDir "nimcache"
--run
switch("out", ("./build/" & name))
setCommand lang, "tests/" & name & ".nim"
task all_tests, "Run all tests - Intel MKL + OpenMP + Cuda + march=native + release":
switch("define","cuda")
cuda_mkl_openmp
test "full_test_suite", "cpp"
task test, "Run all tests - Default BLAS & Lapack":
test "tests_cpu"
task test_no_lapack, "Run all tests - Default BLAS without lapack":
switch("define", "no_lapack")
test "tests_cpu"
task test_cpp, "Run all tests - Cpp codegen":
test "tests_cpu", "cpp"
task test_cuda, "Run all tests - Cuda backend with CUBLAS and CuDNN":
switch("define","cuda")
switch("define","cudnn")
cudaSwitches # Unfortunately the "switch" line doesn't also trigger
# the "when defined(cuda)" part of this nimble file
# hence the need to call cudaSwitches explicitly
test "tests_cuda", "cpp"
task test_opencl, "Run all OpenCL backend tests":
switch("define", "opencl")
test "tests_opencl"
# task test_deprecated, "Run all tests on deprecated procs":
# test "tests_cpu_deprecated"
task test_openblas, "Run all tests - OpenBLAS":
switch("define","blas=openblas")
switch("define","lapack=openblas")
when defined(macosx):
## Should work but somehow Nim doesn't find libopenblas.dylib on MacOS
switch("clibdir", "/usr/local/opt/openblas/lib")
switch("cincludes", "/usr/local/opt/openblas/include")
test "tests_cpu"
task test_blis, "Run all tests - BLIS":
switch("define","blis")
test "tests_cpu"
task test_native, "Run all tests - march=native":
switch("define","native")
test "tests_cpu"
task test_openmp, "Run all tests - OpenMP":
switch("define","openmp")
switch("stackTrace","off") # stacktraces interfere with OpenMP
when defined(macosx): # Default compiler on Mac is clang without OpenMP and gcc is an alias to clang.
# Use Homebrew GCC instead for OpenMP support. GCC (v7), must be properly linked via `brew link gcc`
switch("cc", "gcc")
switch("gcc.exe", "/usr/local/bin/gcc-7")
switch("gcc.linkerexe", "/usr/local/bin/gcc-7")
test "tests_cpu"
task test_mkl, "Run all tests - Intel MKL - single threaded":
mkl_singleSwitches
test "tests_cpu"
task test_mkl_omp, "Run all tests - Intel MKL + OpenMP":
mkl_threadedSwitches
test "tests_cpu"
task test_release, "Run all tests - Release mode":
switch("define","release")
test "tests_cpu"
task gen_doc, "Generate Arraymancer documentation":
# TODO: Industrialize: something more robust that only check nim files (and not .DS_Store ...)
for filePath in listFiles("src/tensor/"):
let modName = filePath[11..^5] # Removing src/tensor/ (11 chars) and .nim (4 chars) # TODO: something more robust
# Cuda doc is broken https://github.com/nim-lang/Nim/issues/6910
# Delete doc comment from nimcuda before using this
exec r"nim doc -o:docs/build/tensor." & modName & ".html " & filePath
for filePath in listFiles("src/nn_primitives/"):
let modName = filePath[18..^5] # Removing src/nn_primitives/ (18 chars) and .nim (4 chars) # TODO: something more robust
# Cuda doc is broken https://github.com/nim-lang/Nim/issues/6910
# Delete doc comment from nimcuda before using this
exec r"nim doc -o:docs/build/nnp." & modName & ".html " & filePath
for filePath in listFiles("src/autograd/"):
let modName = filePath[13..^5] # Removing src/autograd/ (13 chars) and .nim (4 chars) # TODO: something more robust
exec r"nim doc -o:docs/build/ag." & modName & ".html " & filePath
for filePath in listFiles("src/nn/"):
let modName = filePath[7..^5] # Removing src/nn_primitives/ (18 chars) and .nim (4 chars) # TODO: something more robust
exec r"nim doc -o:docs/build/nn." & modName & ".html " & filePath
# TODO auto check subdir
for filePath in listFiles("src/nn/activation/"):
let modName = filePath[18..^5]
exec r"nim doc -o:docs/build/nn_activation." & modName & ".html " & filePath
for filePath in listFiles("src/nn/layers/"):
let modName = filePath[14..^5]
exec r"nim doc -o:docs/build/nn_layers." & modName & ".html " & filePath
for filePath in listFiles("src/nn/loss/"):
let modName = filePath[12..^5]
exec r"nim doc -o:docs/build/nn_loss." & modName & ".html " & filePath
for filePath in listFiles("src/nn/optimizers/"):
let modName = filePath[18..^5]
exec r"nim doc -o:docs/build/nn_optimizers." & modName & ".html " & filePath
for filePath in listFiles("src/nn_dsl/"):
let modName = filePath[11..^5]
exec r"nim doc -o:docs/build/nn_dsl." & modName & ".html " & filePath
for filePath in listFiles("src/linear_algebra/"):
let modName = filePath[19..^5]
exec r"nim doc -o:docs/build/la." & modName & ".html " & filePath
for filePath in listFiles("src/stats/"):
let modName = filePath[10..^5]
exec r"nim doc -o:docs/build/stats." & modName & ".html " & filePath
for filePath in listFiles("src/ml/clustering/"):
let modName = filePath[18..^5]
exec r"nim doc -o:docs/build/ml." & modName & ".html " & filePath
for filePath in listFiles("src/ml/dimensionality_reduction/"):
let modName = filePath[32..^5]
exec r"nim doc -o:docs/build/ml." & modName & ".html " & filePath
for filePath in listFiles("src/ml/metrics/"):
let modName = filePath[15..^5]
exec r"nim doc -o:docs/build/ml." & modName & ".html " & filePath
for filePath in listFiles("src/io/"):
let modName = filePath[7..^5]
exec r"nim doc -o:docs/build/io." & modName & ".html " & filePath
for filePath in listFiles("src/datasets/"):
let modName = filePath[13..^5]
exec r"nim doc -o:docs/build/datasets." & modName & ".html " & filePath
# Process the rst
for filePath in listFiles("docs/"):
if filePath[^4..^1] == ".rst":
let modName = filePath[5..^5]
exec r"nim rst2html -o:docs/build/" & modName & ".html " & filePath
# Copy stylesheets
cpFile("docs/docutils.css", "docs/build/docutils.css")
cpFile("docs/nav.css", "docs/build/nav.css")