cumo 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6898598e4614bd912dfa4e83e31695d7fc5eb256
-  data.tar.gz: 752d37294a51016c0256bcdab6d324ebc975bdac
+SHA256:
+  metadata.gz: 621f319a4a92862c60267ace14b39968fb7e5c203da94bb9d1f01b86412b77b3
+  data.tar.gz: db4964d257fcbe79c6a6f4b8e84ac71f7657c87168d43b7c205d9de5059b02e3
 SHA512:
-  metadata.gz: 81279774f60ac5f38a23751f52a42ae01022d9a5c33cf24d905302def0bc75e20237ad76bb986f4bdd43a184eca14ff3d27da46095189c29217d8fd894dad9fc
-  data.tar.gz: 609ff0cbf6c3a28fc4fafde14f90adfc82ff7efcf268071a73605d61615feb21770e5bddfc8252a042657cbb2bc179f839030e4b85b1f4c11475ed9b27e92ef5
+  metadata.gz: a703d9f146c556af7ef60c869dd44989fdd67d8c2b45f99d337b1cc5dd606a1eace434b46d0b6a7e4a404930351565f2ca3e93f116886a5b915f285a8b1b85d0
+  data.tar.gz: 9fc0c1c794aeb12f9f5a3cf7866bec32439b09083c3b34869301ac5dc3c602845ec3c51e7caa7bf5022d375e448db5c4c6d3f16f77660645b07fdd5dc2bf29c1

data/.gitignore

@@ -25,3 +25,4 @@ t.rb
 *.exe
 .DS_Store
 /vendor/
+.kernel_cache/

data/3rd_party/LICENSE.txt

@@ -0,0 +1,60 @@
+######################################################################
+# The Cumo is a fork of Numo NArray v0.9.0.9.
+# Cumo's source code and documents contain the original Ruby/Numo ones.
+######################################################################
+BSD 3-Clause License
+
+Copyright (c) 1999-2017, Masahiro TANAKA
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+######################################################################
+# The Cumo refers some implementations of CuPy such as memory pool.
+# Cumo's source code and documents contain the original CuPy ones.
+######################################################################
+MIT License
+
+Copyright (c) 2015 Preferred Infrastructure, Inc.
+Copyright (c) 2015 Preferred Networks, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/3rd_party/mkmf-cu/lib/mkmf-cu/cli.rb

@@ -32,7 +32,19 @@ module MakeMakefileCuda
     # TODO(sonots): Make it possible to configure "nvcc" and additional arguments
     def nvcc_command
       s = MakeMakefileCuda::Nvcc.generate(argv)
-      ["nvcc " << s << " -arch=sm_35"]
+      cmd = "nvcc " << s
+      if ENV['CUMO_NVCC_GENERATE_CODE']
+        cmd << " --generate-code=#{ENV['CUMO_NVCC_GENERATE_CODE']}"
+      elsif ENV['DEBUG']
+        cmd << " -arch=sm_35"
+      else
+        cmd << " --generate-code=arch=compute_35,code=sm_35"
+        cmd << " --generate-code=arch=compute_50,code=sm_50"
+        cmd << " --generate-code=arch=compute_60,code=sm_60"
+        cmd << " --generate-code=arch=compute_70,code=sm_70"
+        cmd << " --generate-code=arch=compute_70,code=compute_70"
+      end
+      cmd
     end
 
     def c_command

data/LICENSE.txt

@@ -1,67 +1,6 @@
-BSD 3-Clause License
-
-Copyright (c) 2017 Naotoshi Seo
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
-
-######################################################################
-# The Cumo is a fork of Numo NArray v0.9.0.9.
-# Cumo's source code and documents contain the original Ruby/Numo ones.
-######################################################################
-BSD 3-Clause License
-
-Copyright (c) 1999-2017, Masahiro TANAKA
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-
-* Redistributions of source code must retain the above copyright notice, this
-  list of conditions and the following disclaimer.
-
-* Redistributions in binary form must reproduce the above copyright notice,
-  this list of conditions and the following disclaimer in the documentation
-  and/or other materials provided with the distribution.
-
-* Neither the name of the copyright holder nor the names of its
-  contributors may be used to endorse or promote products derived from
-  this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
-FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-######################################################################
-# The Cumo refers some implementations of CuPy such as memory pool.
-# Cumo's source code and documents contain the original CuPy ones.
-######################################################################
 MIT License
 
-Copyright (c) 2015 Preferred Infrastructure, Inc.
-Copyright (c) 2015 Preferred Networks, Inc.
+Copyright (c) 2017 Naotoshi Seo
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -5,10 +5,11 @@
 Cumo (pronounced like "koomo") is CUDA-aware numerical library whose interface is highly compatible with [Ruby Numo](https://github.com/ruby-numo).
 This library provides the benefit of speedup using GPU by replacing Numo with only a small piece of codes.
 
+<img src="https://raw.githubusercontent.com/sonots/cumo-logo/master/logo_transparent.png" alt="cumo logo" title="cumo logo" width="50%">
 
 ## Requirements
 
-* Ruby 2.0 or later
+* Ruby 2.5 or later
 * NVIDIA GPU Compute Capability 6.0 (Pascal) or later
 * CUDA 9.0 or later
 
@@ -169,23 +170,6 @@ Generate docs:
 bundle exec rake docs
 ```
 
-## Source code organizations
-
-* `*_kernel.{h,cuh,cu}` files are for device (CUDA kernels).
-    * .cu files are compiled via nvcc.
-    * .cu files define C wrapper functions to launch CUDA kernels to enable to be called from .c files.
-    * Technically, it is not possible to use CRuby API such as `VALUE` in .cu files.
-        * CRuby API is not callable from CUDA kernel because they do not have `__device__` modifier.
-        * nvcc does not support `#include RUBY_EXTCONF_H`, so can not include `ruby.h`.
-    * (RULE) It is allowed to use C++14 codes in .cu files.
-* Rest of `*.{h,c}` files are for host (CPU).
-    * Call C wrapper functions defined in .cu files.
-    * It can use CRuby API.
-    * (RULE) It is not allowed to use C++ codes in host files.
-
-Ruby's `mkmf` (or `extconf.rb`) does not support to specify 3rd compiler such as NVCC for another files of extensions `.cu`.
-Therefore, cumo specify a wrapper command `bin/mkmf-cu-nvcc` as a compiler and changes its behavor depending on extensions of files to compile.
-
 ## Advanced Tips on Development
 
 ### ccache
@@ -201,25 +185,21 @@ ln -sf "$HOME/opt/ccache/bin/ccache" "$HOME/opt/ccache/bin/g++"
 ln -sf "$HOME/opt/ccache/bin/ccache" "$HOME/opt/ccache/bin/nvcc"
 ```
 
-## Run tests only a specific line
+### Build in parallel
 
-`--location` option is available as:
+Use `MAKEFLAGS` environment variable to specify `make` command options. You can build in parallel as:
 
 ```
-bundle exec ruby test/narray_test.rb --location 121
+bundle exec MAKEFLAG=-j8 rake compile
 ```
 
-### Compile and run tests only a specific type
-
-`DTYPE` environment variable is available as:
+### Specify nvcc --generate-code options
 
 ```
-bundle exec DTYPE=dfloat rake compile
+bundle exec env CUMO_NVCC_GENERATE_CODE=arch=compute_60,code=sm_60 rake compile
 ```
 
-```
-bundle exec DTYPE=dfloat ruby test/narray_test.rb
-```
+This is useful even on development because it makes possible to skip JIT compilation of PTX to cubin occurring on runtime.
 
 ### Run tests with gdb
 
@@ -237,6 +217,25 @@ bundle exec gdb -x run.gdb --args ruby test/narray_test.rb
 
 You may put a breakpoint by calling `cumo_debug_breakpoint()` at C source codes.
 
+### Run tests only a specific line 
+`--location` option is available as:
+
+```
+bundle exec ruby test/narray_test.rb --location 121
+```
+
+### Compile and run tests only a specific type
+
+`DTYPE` environment variable is available as:
+
+```
+bundle exec DTYPE=dfloat rake compile
+```
+
+```
+bundle exec DTYPE=dfloat ruby test/narray_test.rb
+```
+
 ### Run program always synchronizing CPU and GPU
 
 ```
@@ -249,4 +248,9 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/sonots
 
 ## License
 
-[LICENSE.txt](./LICENSE.txt)
+* [LICENSE.txt](./LICENSE.txt)
+* [3rd_party/LICENSE.txt](./3rd_party/LICENSE.txt)
+
+## Related Materials
+
+* [Fast Numerical Computing and Deep Learning in Ruby with Cumo](https://speakerdeck.com/sonots/fast-numerical-computing-and-deep-learning-in-ruby-with-cumo) - Presentation Slide at [RubyKaigi 2018](https://rubykaigi.org/2018/presentations/sonots.html#may31)

data/bench/cumo_bench.rb

@@ -8,12 +8,14 @@ b = Cumo::Float32.new(10).seq(10,10)
 c = a + b
 c.free
 
-def elementwise
-  puts 'element-wise'
+def elementwise(num = nil)
+  num ||= NUM
+  puts "elementwise(#{num})"
   Benchmark.bm do |r|
     a = Cumo::Float32.new(10000).seq(1)
     b = Cumo::Float32.new(10000).seq(10,10)
     (a + b).free # warm up
+    Cumo::CUDA::Runtime.cudaDeviceSynchronize
     r.report('10**4') do
       NUM.times do
         (a + b).free
@@ -24,6 +26,7 @@ def elementwise
     a = Cumo::Float32.new(100000).seq(1)
     b = Cumo::Float32.new(100000).seq(10,10)
     (a + b).free # warm up
+    Cumo::CUDA::Runtime.cudaDeviceSynchronize
     r.report('10**5') do
       NUM.times do
         (a + b).free
@@ -34,6 +37,7 @@ def elementwise
     a = Cumo::Float32.new(1000000).seq(1)
     b = Cumo::Float32.new(1000000).seq(10,10)
     (a + b).free # warm up
+    Cumo::CUDA::Runtime.cudaDeviceSynchronize
     r.report('10**6') do
       NUM.times do
         (a + b).free
@@ -44,6 +48,7 @@ def elementwise
     a = Cumo::Float32.new(10000000).seq(1)
     b = Cumo::Float32.new(10000000).seq(10,10)
     (a + b).free # warm up
+    Cumo::CUDA::Runtime.cudaDeviceSynchronize
     r.report('10**7') do
       NUM.times do
         (a + b).free
@@ -54,6 +59,7 @@ def elementwise
     a = Cumo::Float32.new(100000000).seq(1)
     b = Cumo::Float32.new(100000000).seq(10,10)
     (a + b).free # warm up
+    Cumo::CUDA::Runtime.cudaDeviceSynchronize
     r.report('10**8') do
       NUM.times do
         (a + b).free
@@ -63,10 +69,13 @@ def elementwise
   end
 end
 
-def reduction
-  puts 'reduction'
+def reduction(num = nil)
+  num ||= NUM
+  puts "reduction(#{num})"
   Benchmark.bm do |r|
     a = Cumo::Float32.new(10000).seq(1)
+    (a.sum).free  # warm up
+    Cumo::CUDA::Runtime.cudaDeviceSynchronize
     r.report('10**4') do
       NUM.times do
         (a.sum).free
@@ -75,6 +84,8 @@ def reduction
     end
 
     a = Cumo::Float32.new(100000).seq(1)
+    (a.sum).free  # warm up
+    Cumo::CUDA::Runtime.cudaDeviceSynchronize
     r.report('10**5') do
       NUM.times do
         (a.sum).free
@@ -83,6 +94,8 @@ def reduction
     end
 
     a = Cumo::Float32.new(1000000).seq(1)
+    (a.sum).free  # warm up
+    Cumo::CUDA::Runtime.cudaDeviceSynchronize
     r.report('10**6') do
       NUM.times do
         (a.sum).free
@@ -91,6 +104,8 @@ def reduction
     end
 
     a = Cumo::Float32.new(10000000).seq(1)
+    (a.sum).free  # warm up
+    Cumo::CUDA::Runtime.cudaDeviceSynchronize
     r.report('10**7') do
       NUM.times do
         (a.sum).free
@@ -99,6 +114,8 @@ def reduction
     end
 
     a = Cumo::Float32.new(100000000).seq(1)
+    (a.sum).free  # warm up
+    Cumo::CUDA::Runtime.cudaDeviceSynchronize
     r.report('10**8') do
       NUM.times do
         (a.sum).free
@@ -108,13 +125,14 @@ def reduction
   end
 end
 
-def dot
-  num = 3
-  puts 'dot'
+def dot(num = nil)
+  num ||= 1
+  puts "dot(#{num})"
   Benchmark.bm do |r|
     a = Cumo::Float32.new(100,100).seq(1)
     b = Cumo::Float32.new(100,100).seq(10,10)
     a.dot(b).free # warm up
+    Cumo::CUDA::Runtime.cudaDeviceSynchronize
     r.report('10**4') do
       num.times do
         a.dot(b).free
@@ -125,6 +143,7 @@ def dot
     a = Cumo::Float32.new(100,1000).seq(1)
     b = Cumo::Float32.new(1000,100).seq(10,10)
     a.dot(b).free # warm up
+    Cumo::CUDA::Runtime.cudaDeviceSynchronize
     r.report('10**5') do
       num.times do
         a.dot(b).free
@@ -135,6 +154,7 @@ def dot
     a = Cumo::Float32.new(100,10000).seq(1)
     b = Cumo::Float32.new(10000,100).seq(10,10)
     a.dot(b).free # warm up
+    Cumo::CUDA::Runtime.cudaDeviceSynchronize
     r.report('10**6') do
       num.times do
         a.dot(b).free
@@ -145,6 +165,7 @@ def dot
     a = Cumo::Float32.new(100,100000).seq(1)
     b = Cumo::Float32.new(100000,100).seq(10,10)
     a.dot(b).free # warm up
+    Cumo::CUDA::Runtime.cudaDeviceSynchronize
     r.report('10**7') do
       num.times do
         a.dot(b).free
@@ -155,6 +176,7 @@ def dot
     a = Cumo::Float32.new(100,1000000).seq(1)
     b = Cumo::Float32.new(1000000,100).seq(10,10)
     a.dot(b).free # warm up
+    Cumo::CUDA::Runtime.cudaDeviceSynchronize
     r.report('10**8') do
       num.times do
         a.dot(b).free
@@ -170,24 +192,24 @@ dot
 
 # Tesla V100-SXM2...
 #
-# element-wise
+# element-wise(100)
 #        user     system      total        real
-# 10**4  0.000000   0.000000   0.000000 (  0.005769)
-# 10**5  0.010000   0.000000   0.010000 (  0.006609)
-# 10**6  0.000000   0.010000   0.010000 (  0.010313)
-# 10**7  0.040000   0.010000   0.050000 (  0.050986)
-# 10**8  0.310000   0.130000   0.440000 (  0.449699)
-# reduction
+# 10**4  0.000000   0.000000   0.000000 (  0.006332)
+# 10**5  0.000000   0.000000   0.000000 (  0.006280)
+# 10**6  0.010000   0.000000   0.010000 (  0.008123)
+# 10**7  0.000000   0.010000   0.010000 (  0.022176)
+# 10**8  0.100000   0.050000   0.150000 (  0.151999)
+# reduction(100)
 #        user     system      total        real
-# 10**4  0.010000   0.000000   0.010000 (  0.009484)
-# 10**5  0.020000   0.010000   0.030000 (  0.022071)
-# 10**6  0.100000   0.050000   0.150000 (  0.152070)
-# 10**7  1.150000   0.600000   1.750000 (  1.754977)
-# 10**8 11.720000   5.750000  17.470000 ( 17.470990)
-# dot
+# 10**4  0.010000   0.000000   0.010000 (  0.009735)
+# 10**5  0.010000   0.010000   0.020000 (  0.022882)
+# 10**6  0.110000   0.050000   0.160000 (  0.154641)
+# 10**7  1.220000   0.590000   1.810000 (  1.805643)
+# 10**8 11.840000   6.110000  17.950000 ( 17.946511)
+# dot(1)
 #        user     system      total        real
-# 10**4  0.000000   0.000000   0.000000 (  0.000351)
-# 10**5  0.000000   0.000000   0.000000 (  0.000838)
-# 10**6  0.000000   0.000000   0.000000 (  0.002702)
-# 10**7  0.020000   0.010000   0.030000 (  0.024650)
-# 10**8  0.180000   0.060000   0.240000 (  0.245101)
+# 10**4  0.000000   0.000000   0.000000 (  0.000206)
+# 10**5  0.000000   0.000000   0.000000 (  0.000195)
+# 10**6  0.000000   0.000000   0.000000 (  0.000239)
+# 10**7  0.000000   0.000000   0.000000 (  0.000719)
+# 10**8  0.010000   0.000000   0.010000 (  0.004636)