numo-openblas 0.1.1 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69ec5184f3c04827324d0fd0d5af5e9b92dd61b7710df099df26379525a48f09
-  data.tar.gz: 41fcc9d0a64991fe1e43d43467c6a98138fd3fa195428e2fb1663ffa571fccca
+  metadata.gz: ac2aed2679cd061818edb12f371deaf05e606c14447b5e37c0e1a6aabb5eab1b
+  data.tar.gz: 0dc9e41b885d24604ca4f334d75341ca5861e3d066ffa077935e878c23e87a33
 SHA512:
-  metadata.gz: 86d775545a967607cfce5c4e824a220224822a05fd2a5796eaa9e9a380b8c909829cf8b2d5e394349b6ff65a75d34729393bab8b25949afe2b9090c415373969
-  data.tar.gz: 158f89106e2611e1fdc29ce9c97f1b235c966eac637523230dca4a14db449febd18b32a7c42416cce973a1c34328b098b9e004f8670001489c8acfe7d0860e3f
+  metadata.gz: c6cb3e8ffa4835247fd029cc4e81d89851d6c02231c86ff7cf61faab914ce239e8595d43ebd3b6668efce5ca94df27ca63605451a9c6f19b2b368090908ec767
+  data.tar.gz: 79da324b51d42b019c66e584b62fabbc1dbb000db91129a1c3f55da8e35af81cb6c7b4d56062abbad89016f492598bbbeaef7604073deb0650cfa4c92f90bc60

data/.github/workflows/build.yml

@@ -0,0 +1,23 @@
+name: build
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [ '2.5', '2.6', '2.7' ]
+    steps:
+      - uses: actions/checkout@v2
+      - name: Install gcc and gfortran
+        run: sudo apt-get install -y gcc gfortran
+      - name: Set up Ruby ${{ matrix.ruby }}
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Build and test with Rake
+        run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3
+          bundle exec rake

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+## 0.3.1
+- Change the version of OpenBLAS to be downloaded to 0.3.13.
+
+## 0.3.0
+- Simplified code for loading of OpenBLAS library.
+
+## 0.2.2
+- Change the version of OpenBLAS to be downloaded to 0.3.12.
+
+## 0.2.1
+- Change the version of OpenBLAS to be downloaded to 0.3.11.
+
+## 0.2.0
+- Add constant values about OpenBLAS.
+- Change to download and build OpenBLAS when building native extension.
+
 ## 0.1.1
 - Fix to check downloaded file's SHA1.
 

data/Gemfile

@@ -4,4 +4,5 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'rake', '~> 12.0'
+gem 'rake-compiler', '~> 1.0'
 gem 'rspec', '~> 3.0'

data/README.md

@@ -1,14 +1,24 @@
 # Numo::OpenBLAS
 
-[![Build Status](https://travis-ci.org/yoshoku/numo-openblas.svg?branch=master)](https://travis-ci.org/yoshoku/numo-openblas)
+[![Build Status](https://github.com/yoshoku/numo-openblas/workflows/build/badge.svg)](https://github.com/yoshoku/numo-openblas/actions?query=workflow%3Abuild)
 [![Gem Version](https://badge.fury.io/rb/numo-openblas.svg)](https://badge.fury.io/rb/numo-openblas)
-[![BSD 3-Clause License](https://img.shields.io/badge/License-BSD%203--Clause-orange.svg)](https://github.com/yoshoku/suika/blob/master/LICENSE.txt)
+[![BSD 3-Clause License](https://img.shields.io/badge/License-BSD%203--Clause-orange.svg)](https://github.com/yoshoku/suika/blob/main/LICENSE.txt)
 
 Numo::OpenBLAS downloads and builds [OpenBLAS](https://www.openblas.net/) during installation and
 uses that as a background library for [Numo::Linalg](https://github.com/ruby-numo/numo-linalg).
 
 ## Installation
 
+Building LAPACK included with OpenBLAS requires Fortran compiler.
+
+macOS:
+
+    $ brew install gfortran
+
+Ubuntu:
+
+    $ sudo apt-get install gfortran
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -39,9 +49,20 @@ c = x.transpose.dot(x)
 eig_val, eig_vec = Numo::Linalg.eigh(c)
 ```
 
+Moreover, some of the build options are defined by constants.
+
+```ruby
+> Numo::OpenBLAS::OPENBLAS_VERSION
+=> " OpenBLAS 0.3.10 "
+> Numo::OpenBLAS::OPENBLAS_CHAR_CORENAME
+=> "HASWELL"
+> Numo::OpenBLAS::OPENBLAS_NUM_CORES
+=> 8
+```
+
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/yoshoku/numo-openblas. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/yoshoku/numo-openblas/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/yoshoku/numo-openblas. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/yoshoku/numo-openblas/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -49,4 +70,4 @@ The gem is available as open source under the terms of the [BSD-3-Clause License
 
 ## Code of Conduct
 
-Everyone interacting in the Numo::Openblas project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/yoshoku/numo-openblas/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Numo::Openblas project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/yoshoku/numo-openblas/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -3,4 +3,13 @@ require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+require 'rake/extensiontask'
+
+task build: :compile
+
+Rake::ExtensionTask.new('openblas') do |ext|
+  ext.ext_dir = 'ext/numo/openblas'
+  ext.lib_dir = 'lib/numo/openblas'
+end
+
+task default: %i[clobber compile spec]

data/ext/numo/openblas/extconf.rb

@@ -0,0 +1,76 @@
+# frozen-string-literal: true
+
+require 'digest/sha1'
+require 'etc'
+require 'fileutils'
+require 'mkmf'
+require 'open-uri'
+require 'open3'
+require 'rubygems/package'
+
+OPENBLAS_VER = '0.3.13'
+OPENBLAS_KEY = '685537a821819ef4dae5901998a57f0eec5bddad'
+OPENBLAS_URI = "https://github.com/xianyi/OpenBLAS/archive/v#{OPENBLAS_VER}.tar.gz"
+OPENBLAS_DIR = File.expand_path(__dir__ + '/../../../vendor')
+
+unless File.exist?("#{OPENBLAS_DIR}/installed_#{OPENBLAS_VER}")
+  puts "Downloading OpenBLAS #{OPENBLAS_VER}."
+  URI.open(OPENBLAS_URI) do |rf|
+    File.open("#{OPENBLAS_DIR}/tmp/openblas.tgz", 'wb') { |sf| sf.write(rf.read) }
+  end
+
+  if OPENBLAS_KEY != Digest::SHA1.file("#{OPENBLAS_DIR}/tmp/openblas.tgz").to_s
+    puts 'SHA1 digest of downloaded file does not match.'
+    exit(1)
+  end
+
+  puts 'Unpacking OpenBLAS tar.gz file.'
+  Gem::Package::TarReader.new(Zlib::GzipReader.open("#{OPENBLAS_DIR}/tmp/openblas.tgz")) do |tar|
+    tar.each do |entry|
+      next unless entry.file?
+
+      filename = "#{OPENBLAS_DIR}/tmp/#{entry.full_name}"
+      next if filename == File.dirname(filename)
+
+      FileUtils.mkdir_p("#{OPENBLAS_DIR}/tmp/#{File.dirname(entry.full_name)}")
+      File.open(filename, 'wb') { |f| f.write(entry.read) }
+      File.chmod(entry.header.mode, filename)
+    end
+  end
+
+  Dir.chdir("#{OPENBLAS_DIR}/tmp/OpenBLAS-#{OPENBLAS_VER}") do
+    puts 'Building OpenBLAS. This could take a while...'
+    mkstdout, _mkstderr, mkstatus = Open3.capture3("make -j#{Etc.nprocessors}")
+    File.open("#{OPENBLAS_DIR}/tmp/openblas.log", 'w') { |f| f.puts(mkstdout) }
+    unless mkstatus.success?
+      puts 'Failed to build OpenBLAS.'
+      puts 'Check the openblas.log file for more details:'
+      puts "#{OPENBLAS_DIR}/tmp/openblas.log"
+      exit(1)
+    end
+
+    puts 'Installing OpenBLAS.'
+    insstdout, _insstderr, insstatus = Open3.capture3("make install PREFIX=#{OPENBLAS_DIR}")
+    File.open("#{OPENBLAS_DIR}/tmp/openblas.log", 'a') { |f| f.puts(insstdout) }
+    unless insstatus.success?
+      puts 'Failed to install OpenBLAS.'
+      puts 'Check the openblas.log file for more details:'
+      puts "#{OPENBLAS_DIR}/tmp/openblas.log"
+      exit(1)
+    end
+
+    FileUtils.touch("#{OPENBLAS_DIR}/installed_#{OPENBLAS_VER}")
+  end
+end
+
+unless find_library('openblas', nil, "#{OPENBLAS_DIR}/lib")
+  puts 'libopenblas is not found.'
+  exit(1)
+end
+
+unless find_header('openblas_config.h', nil, "#{OPENBLAS_DIR}/include")
+  puts 'openblas_config.h is not found.'
+  exit(1)
+end
+
+create_makefile('numo/openblas/openblas')

data/ext/numo/openblas/openblas.c

@@ -0,0 +1,34 @@
+/**
+ * Numo::OpenBLAS downloads and builds OpenBLAS during installation and
+ * uses that as a background library for Numo::Linalg.
+ */
+
+#include <ruby.h>
+#include <openblas_config.h>
+
+VALUE mNumo;
+VALUE mOpenBLAS;
+
+void Init_openblas()
+{
+  /**
+  * Document-module: Numo
+  * Numo is the top level namespace of NUmerical MOdules for Ruby.
+  */
+  mNumo = rb_define_module("Numo");
+
+  /**
+   * Document-module: Numo::Liblinear
+   * Numo::OpenBLAS loads Numo::NArray and Linalg with OpenBLAS used as backend library.
+   */
+  mOpenBLAS = rb_define_module_under(mNumo, "OpenBLAS");
+
+  /* The number of cores detected by OpenBLAS. */
+  rb_define_const(mOpenBLAS, "OPENBLAS_NUM_CORES", INT2NUM(OPENBLAS_NUM_CORES));
+
+  /* The core name detected by OpenBLAS. */
+  rb_define_const(mOpenBLAS, "OPENBLAS_CHAR_CORENAME", rb_str_new_cstr(OPENBLAS_CHAR_CORENAME));
+
+  /* The version of OpenBLAS used in background library. */
+  rb_define_const(mOpenBLAS, "OPENBLAS_VERSION", rb_str_new_cstr(OPENBLAS_VERSION));
+}

data/lib/numo/openblas.rb

@@ -3,28 +3,6 @@
 require 'numo/narray'
 require 'numo/linalg/linalg'
 require 'numo/openblas/version'
+require 'numo/openblas/openblas'
 
-module Numo
-  module Linalg
-    module Loader
-      module_function
-
-      def load_openblas
-        dlext = case RbConfig::CONFIG['host_os']
-                when /mswin|msys|mingw|cygwin/
-                  'dll'
-                when /darwin|mac os/
-                  'dylib'
-                else
-                  'so'
-                end
-        openblas_path = File.expand_path(__dir__ + "/../../vendor/lib/libopenblas.#{dlext}")
-        Numo::Linalg::Blas.dlopen(openblas_path)
-        Numo::Linalg::Lapack.dlopen(openblas_path)
-        @@libs = [openblas_path]
-      end
-    end
-  end
-end
-
-Numo::Linalg::Loader.load_openblas
+Numo::Linalg::Loader.load_openblas(File.expand_path("#{__dir__}/../../vendor/lib/"))

data/lib/numo/openblas/version.rb

@@ -1,12 +1,10 @@
 # frozen_string_literal: true
 
+# Numo is the top level namespace of NUmerical MOdules for Ruby.
 module Numo
   # Numo::OpenBLAS loads Numo::NArray and Linalg with OpenBLAS used as backend library.
   module OpenBLAS
     # The version of Numo::OpenBLAS you install.
-    VERSION = '0.1.1'
-
-    # The version OpenBLAS that Numo::OpenBLAS build and use.
-    OPENBLAS_VERSION = '0.3.10'
+    VERSION = '0.3.1'
   end
 end

data/numo-openblas.gemspec

@@ -19,8 +19,8 @@ Gem::Specification.new do |spec|
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = 'https://github.com/yoshoku/numo-openblas'
-  spec.metadata['changelog_uri'] = 'https://github.com/yoshoku/numo-openblas/blob/master/CHANGELOG.md'
-  spec.metadata['documentation_uri'] = 'https://github.com/yoshoku/numo-openblas/blob/master/README.md'
+  spec.metadata['changelog_uri'] = 'https://github.com/yoshoku/numo-openblas/blob/main/CHANGELOG.md'
+  spec.metadata['documentation_uri'] = 'https://github.com/yoshoku/numo-openblas/blob/main/README.md'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -30,6 +30,7 @@ Gem::Specification.new do |spec|
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
+  spec.extensions    = ['ext/numo/openblas/extconf.rb']
 
   spec.add_runtime_dependency 'numo-linalg', '>= 0.1.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: numo-openblas
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.3.1
 platform: ruby
 authors:
 - yoshoku
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-26 00:00:00.000000000 Z
+date: 2020-12-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: numo-linalg
@@ -30,21 +30,23 @@ description: |
 email:
 - yoshoku@outlook.com
 executables: []
-extensions: []
+extensions:
+- ext/numo/openblas/extconf.rb
 extra_rdoc_files: []
 files:
+- ".github/workflows/build.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- ext/numo/openblas/extconf.rb
+- ext/numo/openblas/openblas.c
 - lib/numo/openblas.rb
 - lib/numo/openblas/version.rb
-- lib/rubygems_plugin.rb
 - numo-openblas.gemspec
 - vendor/tmp/.gitkeep
 homepage: https://github.com/yoshoku/numo-openblas
@@ -53,9 +55,9 @@ licenses:
 metadata:
   homepage_uri: https://github.com/yoshoku/numo-openblas
   source_code_uri: https://github.com/yoshoku/numo-openblas
-  changelog_uri: https://github.com/yoshoku/numo-openblas/blob/master/CHANGELOG.md
-  documentation_uri: https://github.com/yoshoku/numo-openblas/blob/master/README.md
-post_install_message:
+  changelog_uri: https://github.com/yoshoku/numo-openblas/blob/main/CHANGELOG.md
+  documentation_uri: https://github.com/yoshoku/numo-openblas/blob/main/README.md
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -70,8 +72,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key:
+rubygems_version: 3.1.4
+signing_key: 
 specification_version: 4
 summary: Numo::OpenBLAS downloads and builds OpenBLAS during installation and uses
   that as a background library for Numo::Linalg.

data/.travis.yml

@@ -1,16 +0,0 @@
----
-os: linux
-dist: xenial
-language: ruby
-cache: bundler
-rvm:
-  - '2.7'
-
-addons:
-  apt:
-    packages:
-      - gcc
-      - gfortran
-
-before_install:
-  - gem install bundler -v 2.1.2

data/lib/rubygems_plugin.rb

@@ -1,65 +0,0 @@
-# frozen-string-literal: true
-
-require 'rubygems'
-require 'rubygems/package'
-
-require 'digest/sha1'
-require 'etc'
-require 'fileutils'
-require 'open-uri'
-require 'open3'
-
-Gem.post_install do
-  openblas_ver = '0.3.10'
-  openblas_key = 'cbe3fdd0e6ee235debc611d76976dac62f3ddc1c'
-  openblas_uri = "https://github.com/xianyi/OpenBLAS/archive/v#{openblas_ver}.tar.gz"
-  openblas_dir = File.expand_path(__dir__ + '/../vendor')
-
-  next true if File.exist?("#{openblas_dir}/installed_#{openblas_ver}")
-
-  puts "Downloading OpenBLAS #{openblas_ver}."
-  URI.open(openblas_uri) do |rf|
-    File.open("#{openblas_dir}/tmp/openblas.tgz", 'wb') { |sf| sf.write(rf.read) }
-  end
-
-  next false if openblas_key != Digest::SHA1.file("#{openblas_dir}/tmp/openblas.tgz").to_s
-
-  puts 'Unpacking OpenBLAS tar.gz file.'
-  Gem::Package::TarReader.new(Zlib::GzipReader.open("#{openblas_dir}/tmp/openblas.tgz")) do |tar|
-    tar.each do |entry|
-      next unless entry.file?
-
-      filename = "#{openblas_dir}/tmp/#{entry.full_name}"
-      next if filename == File.dirname(filename)
-
-      FileUtils.mkdir_p("#{openblas_dir}/tmp/#{File.dirname(entry.full_name)}")
-      File.open(filename, 'wb') { |f| f.write(entry.read) }
-      File.chmod(entry.header.mode, filename)
-    end
-  end
-
-  Dir.chdir("#{openblas_dir}/tmp/OpenBLAS-#{openblas_ver}") do
-    puts 'Building OpenBLAS. This could take a while...'
-    mkstdout, _mkstderr, mkstatus = Open3.capture3("make -j#{Etc.nprocessors}")
-    File.open("#{openblas_dir}/tmp/openblas.log", 'w') { |f| f.puts(mkstdout) }
-    unless mkstatus.success?
-      puts 'Failed to build OpenBLAS.'
-      puts 'Check the make-openblas.log file for more details:'
-      puts "#{openblas_dir}/tmp/openblas.log"
-      break false
-    end
-
-    puts 'Installing OpenBLAS.'
-    insstdout, _insstderr, insstatus = Open3.capture3("make install PREFIX=#{openblas_dir}")
-    File.open("#{openblas_dir}/tmp/openblas.log", 'a') { |f| f.puts(insstdout) }
-    unless insstatus.success?
-      puts 'Failed to install OpenBLAS.'
-      puts 'Check the make-openblas.log file for more details:'
-      puts "#{openblas_dir}/tmp/openblas.log"
-      break false
-    end
-
-    FileUtils.touch("#{openblas_dir}/installed_#{openblas_ver}")
-    true
-  end
-end