mnist-learn 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ae87b3ff341c6db37f9d503da3c135a850546852
+  data.tar.gz: 78897ffc8dec031485af30fd87f2f7a71fc47a09
+SHA512:
+  metadata.gz: 4aafa7cd4149b0014548247472eedc81443660d674f4861b7a3824c9d7b04fcd72b4bd7f331dc514d7e95196ec056c5d8c0b2d64095d5fc04d693e05f935ffc7
+  data.tar.gz: feaa0c636fa9d0be6ac078bb10431966174242477d77390a78344b588eb8b727ef87fc36342ff9c4db61bed0601b86d8a5d78a14695c82f4826468caac802a7a

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/spec/fixtures/data
+/tmp/
+/data

data/.rspec_status

@@ -0,0 +1,4 @@
+example_id                  | status | run_time     |
+--------------------------- | ------ | ------------ |
+./spec/mnist_spec.rb[1:1:1] | passed | 6.54 seconds |
+./spec/mnist_spec.rb[1:1:2] | failed | 2.62 seconds |

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mnist.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Kenta Murata
+
+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,52 @@
+# Mnist
+
+Utility ruby gem for easily loading and parsing the MNIST Database of handwritten digits for machine learning purposes.
+
+Based on work by kenta murata.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mnist-learn'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mnist-learn
+
+## Usage
+
+Load test and training data easily.
+
+```ruby
+require 'mnist-learn'
+
+minst = Mnist.read_data_sets('data', one_hot: false) # auto download test and training archives and store them in /data
+images = minst.train.images
+labels = minst.train.labels
+
+#you can also iterate in batches
+
+train_images, train_labels = minst.train.next_batch(100)
+test_images, test_labels = minst.test.next_batch(100)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/mnist-learn/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/exe/mnist2csv

@@ -0,0 +1,45 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'mnist'
+
+require 'optparse'
+
+num_sample = nil
+
+opt = OptionParser.new
+opt.banner = "Usage: #{$0} [options] IMAGE_FILE LABEL_FILE"
+opt.version = Mnist::VERSION
+opt.separator ''
+opt.separator 'Options:'
+opt.on('-n', '--sample=N', Integer, 'The number of samples') {|v| num_sample = v }
+opt.parse!(ARGV)
+
+nrows, ncols, images = Mnist.load_images(ARGV[0])
+labels = Mnist.load_labels(ARGV[1])
+
+if images.length != labels.length
+  raise "The lengths of images and labels are not same"
+end
+
+print "y"
+(nrows*ncols).times do |i|
+  print ",x#{i}"
+end
+print "\r\n"
+
+indices = 0...labels.length
+indices = [*indices].sample(num_sample) if num_sample
+
+indices.each do |index|
+  label = labels[index]
+  print label
+
+  image = images[index]
+  pixels = image.unpack('C*')
+  pixels.each do |pixel|
+    print ",#{pixel}"
+  end
+
+  print "\r\n"
+end

data/lib/mnist-learn/version.rb

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

data/lib/mnist-learn.rb

@@ -0,0 +1,188 @@
+require "mnist-learn/version"
+require 'fileutils'
+require 'zlib'
+require 'net/http'
+require 'ostruct'
+
+module Mnist
+  class Error < StandardError; end
+
+  class LoadError < Error; end
+
+  class InvalidMagic < LoadError; end
+
+  class MnistReader
+    def initialize(base_path, one_hot = false)
+      @base_path = base_path
+      @one_hot = one_hot
+    end
+
+    def train
+      load_pair('train-images-idx3-ubyte', 'train-labels-idx1-ubyte')
+    end
+
+    def test
+      load_pair('t10k-images-idx3-ubyte', 't10k-labels-idx1-ubyte')
+    end
+
+    private
+
+    def load_pair(images, labels)
+      Loader.new(File.join(@base_path, images), File.join(@base_path, labels), @one_hot)
+    end
+  end
+
+  class Loader
+    IMAGE_FILE_MAGIC = 2051
+    LABEL_FILE_MAGIC = 2049
+
+    def initialize(filename_image, filename_label, one_hot)
+      @filename_image = filename_image
+      @filename_label = filename_label
+      @one_hot = one_hot
+      @index = 0
+    end
+
+    attr_reader :filename_image, :filename_label
+
+    def load_images
+      check_magic(input_images, IMAGE_FILE_MAGIC)
+      @total_count = read_total_count(input_images)
+      nrows, ncols = read_image_size(input_images)
+      images = @total_count.times.map do
+        read_image(nrows, ncols)
+      end
+      [nrows, ncols, images]
+    end
+
+    def load_labels
+      check_magic(input_labels, LABEL_FILE_MAGIC)
+      @total_count = read_total_count(input_labels)
+      read_labels(input_labels, @total_count)
+    end
+
+    def images
+      @all_images ||= load_images[2]
+    end
+
+    def labels
+      @all_labels ||= load_labels
+    end
+  
+    def next_batch(batch_size)
+      if @index == 0
+          @rows, @columns, @images = load_images
+          @labels = load_labels
+      end
+      images = []
+      labels = []
+      batch_size.times.each do
+        next if @index >= @total_count
+          image_data = @images[@index]
+          label_data = @labels[@index]
+          image_data.map! { |b| b.to_f / 255.0 }
+          @index += 1
+          images << image_data
+          labels << (@one_hot ? one_hot_transform(label_data) : label_data.to_f)
+      end
+      [images, labels]
+    end
+  
+    private
+
+    def one_hot_transform(label)
+      arr = Array.new(10) { 0.0 }
+      arr[label] = 1.0
+      arr
+    end
+
+    def check_magic(input_file, expected_magic)
+      actual_magic = read_magic(input_file)
+      unless actual_magic == expected_magic
+        raise InvalidMagic, "Expected #{expected_magic}, but #{actual_magic} is given"
+      end
+    end
+
+    def read_uint8(input_file, n=1)
+      input_file.read(n).unpack('C*')
+    end
+
+    def read_uint32(input_file, n=1)
+      input_file.read(4 * n).unpack('N*')
+    end
+
+    def read_magic(input_file)
+      read_uint32(input_file).first
+    end
+
+    def read_total_count(input_file)
+      read_uint32(input_file).first
+    end
+
+    def read_image_size(input_file)
+      read_uint32(input_file, 2)
+    end
+
+    alias read_labels read_uint8
+
+    def read_image(nrows, ncols)
+      input_images.read(nrows * ncols).unpack("C*")
+    end
+
+    def input_images
+      @input_images ||= File.open(filename_image)
+    end
+
+    def input_labels
+      @input_labels ||= File.open(filename_label)
+    end
+  end
+
+  def self.load_images(filename)
+    Loader.new(filename).load_images
+  end
+
+  def self.load_labels(filename)
+    Loader.new(filename).load_labels
+  end
+
+  def self.read_data_sets(path, one_hot: false)
+    unless Dir.exist?(path)
+      FileUtils.mkdir_p path
+    end
+
+    base_url = "yann.lecun.com"
+    filenames = [
+      "train-images-idx3-ubyte.gz",
+      "train-labels-idx1-ubyte.gz",
+      "t10k-images-idx3-ubyte.gz",
+      "t10k-labels-idx1-ubyte.gz"
+    ]
+    Net::HTTP.start(base_url) do |http|
+      filenames.each do |name|
+        unless File.exists?(File.join(path, name))
+          f = File.open(File.join(path, name), "w")
+          begin
+            http.request_get('/exdb/mnist/' + name) do |resp|
+              resp.read_body do |segment|
+                f.write(segment)
+              end
+            end
+          ensure
+            f.close
+          end
+        end
+      end
+    end
+
+    filenames.each do |name|
+      next if File.exists?(File.join(path, File.basename(name, '.gz')))
+      puts "extracting #{name} ..."
+      Zlib::GzipReader.open(File.join(path, name)) do |zipfile|
+        outfile = File.open(File.join(path, File.basename(name, '.gz')), 'w')
+        outfile.write(zipfile.read)
+      end
+    end
+    MnistReader.new(path, one_hot)
+  end
+end

data/mnist-learn.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mnist-learn/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mnist-learn"
+  spec.version       = Mnist::VERSION
+  spec.authors       = ["Joseph Dayo"]
+  spec.email         = ["joseph.dayo@gmail.com"]
+
+  spec.summary       = %q{Utilities for MNIST handwritten digits data}
+  spec.description   = %q{Utilities for MNIST handwritten digits data}
+  spec.homepage      = "https://github.com/jedld/ruby-mnist"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "awesome_print"
+end

data/script/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mnist"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/script/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: mnist-learn
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joseph Dayo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-05-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: pry-byebug
+  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: awesome_print
+  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'
+description: Utilities for MNIST handwritten digits data
+email:
+- joseph.dayo@gmail.com
+executables:
+- mnist2csv
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec_status"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/mnist2csv
+- lib/mnist-learn.rb
+- lib/mnist-learn/version.rb
+- mnist-learn.gemspec
+- script/console
+- script/setup
+homepage: https://github.com/jedld/ruby-mnist
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Utilities for MNIST handwritten digits data
+test_files: []