rbmnist 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6090901ee5fd4ae17ef267126a87050efed6640bbaeed1e2b62ad268289ccd77
+  data.tar.gz: 8bb67f9b366c8ca1681b1bda324d8b4a9da41387fd6becb6026c61a90c081a88
+SHA512:
+  metadata.gz: e4d16ab6550b4e7c08ff4ab85f6c3d4ef2f0bd795ac5793282cddb7a5f2d98d41c1d9e4ef663a0b21fa42977d714f503d01781e373e9bd96fc92610c1d0dca1c
+  data.tar.gz: 718989ce91cd2df3caf9e4fd64e72044b0b1bff4fafe8e448474879c6444e9209dde88ccc604aaffb0e5cb428b191114beb2401845477414d4124a7475c3ac74

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+*.png

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at micah.shute@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,15 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rbmnist.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+
+gem "byteman", "~> 0.1.1"
+
+gem "rbimg", "~> 0.1.4"
+
+gem "pry", "~> 0.13.1", group: :development
+
+gem "gspec", "~> 0.1.3", group: :development

data/Gemfile.lock

@@ -0,0 +1,49 @@
+PATH
+  remote: .
+  specs:
+    rbmnist (0.1.0)
+      byteman
+      rbimg
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byteman (0.1.1)
+    coderay (1.1.3)
+    diff-lcs (1.4.4)
+    gspec (0.1.3)
+    method_source (1.0.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (12.3.3)
+    rbimg (0.1.4)
+      byteman (~> 0.1.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byteman (~> 0.1.1)
+  gspec (~> 0.1.3)
+  pry (~> 0.13.1)
+  rake (~> 12.0)
+  rbimg (~> 0.1.4)
+  rbmnist!
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 micahshute
+
+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,113 @@
+# Rbmnist
+
+Quick, easy way to get MNIST data in ruby without downlaoding, unzipping, and processing it yourself. 
+
+The Train set has 60000 images in it with associated labels. The test set has 10000 images in it with associated labels.
+The first 5000 images of the test set are clearer than the last 5000, and can be accessed simply (see below)
+
+Allows access to image pixel data, and easy visualization (see examples and below).
+
+Supports lazy loading.
+
+Images are wrapped in an Rbmnist::ImageWrapper object, which mirrors many array methods ([], []=, each, and map). 
+The raw pixel array can be retreived via #data and #pixel
+
+Labels are simply an array of integers
+
+To load: 
+```ruby
+Rbmnist::MNIST.load # Load everything
+Rbmnist::MNIST.load_test # Load just test images and labels
+Rbmnist::MNIST.load_train # Load just the train images and labels
+```
+Otherwise, the applicable data will be loaded when it is accessed:
+
+```ruby
+Rbmnist::MNIST::Test.images # this will load only the test images and then return them as an array of Rbmnist::ImageWrapper objects
+Rbmnist::MNIST::Train.labels # this will load only the train labels and return them as an array of integers
+```
+
+Basic usage:
+
+```ruby
+#Can load everything or lazy load when you need it, like above
+require 'rbmnist'
+
+Rbmnist::MNIST.load
+
+train_imgs = Rbmnist::MNIST::Train.images
+train_labels = Rbmnist::MNIST::Train.labels
+
+test_imgs = Rbmnist::MNIST::Test.images
+test_labels = Rbmnist::MNIST::Test.labels
+
+clean_test_images = Rbmnist::MNIST::Test.clean_images # the first 5000 images from the Test data is cleaner
+clean_test_labels = Rbmnist::MNIST::Test.clean_labels # Note that clean_images and clean_labels use the #images and #labels methods, so they lazy load as well
+
+
+# Images are Rbmnist::ImageWrapper objects. You can operate on their pixels directly or use methods to alter your data type
+
+#Direct manipulation
+
+train_img = train_imgs.first
+first_20_pixels = train_img[0...20]
+train_img.each do |pixel|
+    # do something to each pixel
+end
+
+train_img.map do |pixel|
+    # map each pixel
+end
+
+# Turn ImageWrapper into an array or a PNG:
+
+img_pixel_array = train_img.to_a # or train_img.pixels or train_img.data
+
+img_pixel_2d_array = train_img.to_a_2d # returns 2d array representing the rows/columns of pixels in image
+
+png = train_img.to_png
+png.write(path: "./my_mnst_img")
+
+puts "The image my_mnst_img.png should be a #{train_labels.first}"
+
+```
+
+
+
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rbmnist'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rbmnist
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also 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`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/micahshute/rbmnist. 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/micahshute/rbmnist/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Rbmnist project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/rbmnist/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,16 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+spec = Gem::Specification.find_by_name 'gspec'
+load "#{spec.gem_dir}/lib/gspec/tasks/generator.rake"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+
+task :console do
+    require 'pry'
+    require_relative './lib/rbmnist'
+    Pry.start
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rbmnist"
+
+# 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(__FILE__)

data/bin/setup

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

data/examples/make_images.rb

@@ -0,0 +1,6 @@
+require './lib/rbmnist'
+
+Rbmnist::MNIST.load_test
+Rbmnist::MNIST::Test.images.take(5).map(&:to_png).each.with_index do |png, i|
+    png.write(path: "./mnist-#{i}")
+end

data/lib/concerns/unzippable.rb

@@ -0,0 +1,8 @@
+module Rbmnist::Unzippable
+
+    def unzip_from_path(path)
+        unzipped_enum = Zlib::GzipReader.new(File.open(path))
+        unzipped_enum.each_byte.to_a
+    end
+
+end

data/lib/rbmnist.rb

@@ -0,0 +1,13 @@
+require_relative "./rbmnist/version"
+
+require 'byteman'
+require 'rbimg'
+require 'zlib'
+
+module Rbmnist
+
+end
+
+require_relative './concerns/unzippable' 
+require_relative './rbmnist/image_wrapper'
+require_relative './rbmnist/mnist'

data/lib/rbmnist/image_wrapper.rb

@@ -0,0 +1,47 @@
+class Rbmnist::ImageWrapper
+
+    WIDTH = 28
+    HEIGHT = 28
+
+    attr_reader :data
+
+    def initialize(data)
+        @data = data
+    end
+
+    def pixels
+        @data
+    end
+
+    def to_a
+        return data
+    end
+
+    def [](arg)
+        @data[arg]
+    end
+
+    def []=(val, newval)
+        @data[val] = newval
+    end
+
+    def each(&block)
+        @data.each(&block)
+    end
+
+    def map(&block)
+        @data.map(&block)
+    end
+
+    def to_a_2d
+        Array.new(HEIGHT) do |row|
+            rowstart = row * WIDTH
+            rowend = rowstart + WIDTH
+            @data[rowstart...rowend]
+        end
+    end
+
+    def to_png
+        Rbimg::PNG.new(pixels: @data, type: :greyscale, width: WIDTH, height: HEIGHT)
+    end
+end

data/lib/rbmnist/mnist.rb

@@ -0,0 +1,97 @@
+class Rbmnist::MNIST
+
+
+    def self.load
+        load_test
+        load_train
+    end
+
+    def self.load_test
+        Test.images
+        Test.labels
+        nil
+    end
+
+    def self.load_train
+        Train.images
+        Train.labels
+        nil
+    end
+
+
+
+    class Test
+
+        IMAGE_COUNT = 10000
+        CLEAN_IMAGE_COUNT = 5000
+
+        extend Rbmnist::Unzippable
+
+        @@images = []
+        @@labels = []
+
+        def self.images
+            if @@images.length == 0
+                img_bytes = unzip_from_path(__dir__ + '/../../data/t10k-images-idx3-ubyte.gz')
+                curr_byte = 16
+                @@images = Array.new(IMAGE_COUNT) do |pic|
+                    Rbmnist::ImageWrapper.new(img_bytes[curr_byte...(curr_byte += 784)])
+                end
+            end
+            @@images
+        end
+
+        def self.clean_images
+            images[0...CLEAN_IMAGE_COUNT]
+        end
+
+        def self.clean_labels
+            labels[0...CLEAN_IMAGE_COUNT]
+        end
+
+        def self.labels
+            if @@labels.length == 0
+                label_bytes = unzip_from_path(__dir__ + '/../../data/t10k-labels-idx1-ubyte.gz')
+                curr_byte = 8
+                @@labels = Array.new(IMAGE_COUNT) do |label|
+                    label_bytes[curr_byte...(curr_byte += 1)].first
+                end
+            end
+            @@labels
+        end
+    end
+
+    class Train
+
+        IMAGE_COUNT = 60000
+        extend Rbmnist::Unzippable
+
+        @@images = []
+        @@labels = []
+
+        def self.images
+            if @@images.length == 0
+                img_bytes = unzip_from_path(__dir__ + '/../../data/train-images-idx3-ubyte.gz')
+                curr_byte = 16
+                @@images = Array.new(IMAGE_COUNT) do |pic|
+                    Rbmnist::ImageWrapper.new(img_bytes[curr_byte...(curr_byte += 784)])
+                end
+            end
+            @@images
+        end
+
+        def self.labels
+            if @@labels.length == 0
+                label_bytes = unzip_from_path(__dir__ + '/../../data/train-labels-idx1-ubyte.gz')
+                curr_byte = 8
+                @@labels = Array.new(IMAGE_COUNT) do |label|
+                    label_bytes[curr_byte...(curr_byte += 1)].first
+                end
+            end
+            @@labels
+        end
+
+
+    end
+
+end

data/lib/rbmnist/version.rb

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

data/rbmnist.gemspec

@@ -0,0 +1,31 @@
+require_relative 'lib/rbmnist/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rbmnist"
+  spec.version       = Rbmnist::VERSION
+  spec.authors       = ["micahshute"]
+  spec.email         = ["micah.shute@gmail.com"]
+
+  spec.summary       = %q{Easy access to MNIST data to manipulate}
+  spec.description   = %q{No network calls, manipulate MNIST data easily. Divided up into train and test, and able to write the images as PNG files}
+  spec.homepage      = "https://github.com/micahshute/rbmnist"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = spec.homepage
+
+  # 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.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.add_dependency('byteman')
+  spec.add_dependency('rbimg')
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: rbmnist
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- micahshute
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-07-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: byteman
+  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: rbimg
+  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'
+description: No network calls, manipulate MNIST data easily. Divided up into train
+  and test, and able to write the images as PNG files
+email:
+- micah.shute@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- data/t10k-images-idx3-ubyte.gz
+- data/t10k-labels-idx1-ubyte.gz
+- data/train-images-idx3-ubyte.gz
+- data/train-labels-idx1-ubyte.gz
+- examples/make_images.rb
+- lib/concerns/unzippable.rb
+- lib/rbmnist.rb
+- lib/rbmnist/image_wrapper.rb
+- lib/rbmnist/mnist.rb
+- lib/rbmnist/version.rb
+- rbmnist.gemspec
+homepage: https://github.com/micahshute/rbmnist
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/micahshute/rbmnist
+  source_code_uri: https://github.com/micahshute/rbmnist
+  changelog_uri: https://github.com/micahshute/rbmnist
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Easy access to MNIST data to manipulate
+test_files: []