npy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d8382d17139cd8c1b47882130b5612fd7d748923ead1e763a46e9f0c1e819e08
+  data.tar.gz: 26355f76370731fb6aa3eead0291cb845afa532bdc5ce7bf35a42eccc52a3819
+SHA512:
+  metadata.gz: 5f3e1672b1a9f378bcddd7e8783880d062dd5ffa672b72026ef5a28d862076f2200f2f86fc447feb2bea5e0113606f7bb44b8bb2c174fb1a639d634cc3e745d1
+  data.tar.gz: a4562cfb5e8511d2624e687b4fa06a304ab07075f6eb44083decc00895618b044190467d06f0793fb44c826c7b0e2f2ae5b1c61216a87c57c62f4fca05d2704c

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.1.0
+
+- First release

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2019 Andrew Kane
+
+MIT License
+
+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/README.md

@@ -0,0 +1,73 @@
+# Npy
+
+Load NumPy `npy` and `npz` files in Ruby - no Python required
+
+:fire: Uses [Numo::NArray](https://github.com/ruby-numo/numo-narray) for blazing performance
+
+## Installation
+
+Add this line to your application’s Gemfile:
+
+```ruby
+gem 'npy'
+```
+
+## Getting Started
+
+### npy
+
+`npy` files contain a single array
+
+Load an `npy` file
+
+```ruby
+arr = Npy.load("x.npy")
+```
+
+Load an `npy` string
+
+```ruby
+byte_str = File.binread("x.npy")
+arr = Npy.load_string(byte_str)
+```
+
+### npz
+
+`npz` files contain multiple arrays
+
+Load an `npz` file
+
+```ruby
+arrs = Npy.load_npz("mnist.npz")
+```
+
+Get keys
+
+```ruby
+arrs.keys
+```
+
+Get an array
+
+```ruby
+arrs["x"]
+```
+
+Arrays are lazy loaded for performance
+
+## Resources
+
+- [npy format](https://docs.scipy.org/doc/numpy/reference/generated/numpy.lib.format.html#module-numpy.lib.format)
+
+## History
+
+View the [changelog](https://github.com/ankane/npy/blob/master/CHANGELOG.md)
+
+## Contributing
+
+Everyone is encouraged to help improve this project. Here are a few ways you can help:
+
+- [Report bugs](https://github.com/ankane/npy/issues)
+- Fix bugs and [submit pull requests](https://github.com/ankane/npy/pulls)
+- Write, clarify, or fix documentation
+- Suggest or add new features

data/lib/npy.rb

@@ -0,0 +1,111 @@
+# dependencies
+require "numo/narray"
+require "zip"
+
+# modules
+require "npy/file"
+require "npy/version"
+
+module Npy
+  class Error < StandardError; end
+
+  MAGIC_STR = "\x93NUMPY".b
+
+  class << self
+    def load(path)
+      with_file(path) do |f|
+        load_io(f)
+      end
+    end
+
+    def load_npz(path)
+      with_file(path) do |f|
+        load_npz_io(f)
+      end
+    end
+
+    def load_string(byte_str)
+      load_io(StringIO.new(byte_str))
+    end
+
+    # rubyzip not playing nicely with StringIO
+    # def load_npz_string(byte_str)
+    #   load_npz_io(StringIO.new(byte_str))
+    # end
+
+    def load_io(io)
+      magic = io.read(6)
+      raise Error, "Invalid npy format" unless magic&.b == MAGIC_STR
+
+      major_version = io.read(1)
+      minor_version = io.read(1)
+      raise Error, "Unsupported version" unless major_version == "\x01".b
+
+      header_len = io.read(2).unpack1("S<")
+      header = io.read(header_len)
+      descr, fortran_order, shape = parse_header(header)
+      raise Error, "Fortran order not supported" if fortran_order
+
+      klass =
+        case descr
+        when "|i1"
+          Numo::Int8
+        when "<i2"
+          Numo::Int16
+        when "<i4"
+          Numo::Int32
+        when "<i8"
+          Numo::Int64
+        when "|u1"
+          Numo::UInt8
+        when "<u2"
+          Numo::UInt16
+        when "<u4"
+          Numo::UInt32
+        when "<u8"
+          Numo::UInt64
+        when "<f4"
+          Numo::SFloat
+        when "<f8"
+          Numo::DFloat
+        when "<c8"
+          Numo::SComplex
+        when "<c16"
+          Numo::DComplex
+        else
+          raise Error, "Type not supported: #{descr}"
+        end
+
+      klass.from_binary(io.read, shape)
+    end
+
+    def load_npz_io(io)
+      File.new(io)
+    end
+
+    private
+
+    def with_file(path)
+      ::File.open(path, "rb") do |f|
+        yield f
+      end
+    end
+
+    # header is Python dict, so use regex to parse
+    def parse_header(header)
+      # descr
+      m = /'descr': '([^']+)'/.match(header)
+      descr = m[1]
+
+      # fortran_order
+      m = /'fortran_order': ([^,]+)/.match(header)
+      fortran_order = m[1] == "True"
+
+      # shape
+      m = /'shape': \(([^)]+)\)/.match(header)
+      shape = m[1].split(", ").map(&:to_i)
+
+      [descr, fortran_order, shape]
+    end
+  end
+end

data/lib/npy/file.rb

@@ -0,0 +1,26 @@
+module Npy
+  class File
+    def initialize(io)
+      @streams = {}
+      Zip::File.open_buffer(io) do |zipfile|
+        zipfile.each do |entry|
+          name = entry.name.sub(/\.npy\z/, "")
+          @streams[name] = entry.get_input_stream
+        end
+      end
+      @data = {}
+    end
+
+    def keys
+      @streams.keys
+    end
+
+    def [](name)
+      @data[name] ||= Npy.load_io(@streams[name]) if @streams[name]
+    end
+
+    def to_h
+      keys.map { |k| [k, self[k]] }.to_h
+    end
+  end
+end

data/lib/npy/version.rb

@@ -0,0 +1,3 @@
+module Npy
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: npy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrew Kane
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-09-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: numo-narray
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+description: 
+email: andrew@chartkick.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/npy.rb
+- lib/npy/file.rb
+- lib/npy/version.rb
+homepage: https://github.com/ankane/npy
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Load NumPy npy and npz files in Ruby
+test_files: []