torch-som 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d44e4671b5a2e86749ec1e11ff05cb811259d9804896f786b18b8768e7d8ef28
+  data.tar.gz: 0ac72b332777eeb98e62b1e2193daac3d91499a0c90dd2148a05a261db7f402a
+SHA512:
+  metadata.gz: 604fafabcb0312e4cdba6159d2c7fdec9cf4a9d139c1f27daca2d1e58ae61b6ad15ae3b521328ee215696f77f60779e5317f61133d3423ce3c1869c6cbb31ba8
+  data.tar.gz: d978191e62445d227aad144350da56414baad9b87ffebe1b1d365f58403b78773ff22f866af7622b1bf6c4fd8a6377ac4973c6713e92b394ffb114969f2772a7

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-10-26
+
+- Initial release
+- SOM class
+- Monotonic descent for ratios
+- Basic example inspired by https://codesachin.wordpress.com/2015/11/28/self-organizing-maps-with-googles-tensorflow/

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in torch-som.gemspec
+gemspec
+
+gem 'matplotlib'
+gem 'numpy'
+gem 'tqdm'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Ivan Razuvaev
+
+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,39 @@
+# Torch::Som
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/torch/som`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'torch-som'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install torch-som
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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 the created tag, 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/[USERNAME]/torch-som.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/example.rb

@@ -0,0 +1,51 @@
+require 'optparse'
+require 'torch/som'
+require 'csv'
+require 'matplotlib/pyplot'
+require 'numpy'
+require 'tqdm'
+
+options = {
+  x: 20,
+  y: 10,
+  iterations: 100,
+  output: 'output.png'
+}
+
+optparser = OptionParser.new do |opts|
+  opts.banner = "bundle exec ruby #{__FILE__} [OPTIONS]"
+  opts.on('-x X', Integer, "X resolution of map (default: #{options[:x]})")
+  opts.on('-y Y', Integer, "Y resolution of map (default: #{options[:x]})")
+  opts.on('-o', '--output FILE', "Output map picture filename (default: #{options[:output]})")
+  opts.on('-n', '--iterations NUM', Integer, "Number of iterations (default: #{options[:iterations]})")
+end.parse!(into: options)
+
+input = [
+  [0.0, 0.0, 0.0],
+  [0.0, 0.0, 1.0],
+  [0.0, 0.0, 0.5],
+  [0.125, 0.529, 1.0],
+  [0.33, 0.4, 0.67],
+  [0.6, 0.5, 1.0],
+  [0.0, 1.0, 0.0],
+  [1.0, 0.0, 0.0],
+  [0.0, 1.0, 1.0],
+  [1.0, 0.0, 1.0],
+  [1.0, 1.0, 0.0],
+  [1.0, 1.0, 1.0],
+  [0.33, 0.33, 0.33],
+  [0.5, 0.5, 0.5],
+  [0.66, 0.66, 0.66]
+]
+
+som = Torch::NN::SOM.new(
+  options[:x], 
+  options[:y], 
+  dim: input.first.size, iterations: options[:iterations]
+)
+som.fit input
+#som.fit input, progress: [:with_progress, {desc: "Fitting"}]
+
+plt = Matplotlib::Pyplot
+plt.imshow Numpy.asarray(som.weights_2d.to_a)
+plt.savefig options[:output]

data/lib/torch/som/descent/base.rb

@@ -0,0 +1,17 @@
+require 'torch-rb'
+
+module Torch
+  module NN
+    class SelfOrganizedMap < Torch::NN::Module
+      module Descent
+        class Base
+          attr_reader :iterations
+
+          def call(step_number = nil)
+            raise NotImplementedError
+          end
+        end
+      end
+    end
+  end
+end

data/lib/torch/som/descent/monotonic.rb

@@ -0,0 +1,31 @@
+require_relative 'base'
+
+module Torch
+  module NN
+    class SelfOrganizedMap < Torch::NN::Module
+      module Descent
+        class Monotonic < Base
+          def initialize(initial:, iterations:)
+            raise ArgumentError, "Iterations number must be a positive integer" unless iterations.is_a?(Integer) && iterations > 0
+            @iterations = iterations
+            
+            raise ArgumentError, "Initial value must be a positive integer" unless initial.is_a?(Numeric) && initial > 0
+            @initial = initial
+            @step_number = 0
+          end
+
+          def call(step_number = nil)
+            if step_number
+              raise ArgumentError, "Step number must be an integer >= 0" unless step_number.is_a?(Integer) && step_number >= 0
+              @step_number = step_number
+            end
+            res = @initial * (1.0 - @step_number.to_f / @iterations)
+            @step_number += 1 if @step_number < @iterations
+            
+            res
+          end
+        end
+      end
+    end
+  end
+end

data/lib/torch/som/version.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'torch-rb'
+
+module Torch
+  module NN
+    class SelfOrganizedMap < Torch::NN::Module
+      VERSION = "0.1.0"
+    end
+  end
+end

data/lib/torch/som.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+require_relative "som/version"
+require_relative "som/descent/monotonic"
+
+module Torch
+  module NN
+    class SelfOrganizedMap < Torch::NN::Module
+      attr_reader :weights, :node_coordinates
+
+      def initialize(
+        x, y, 
+        dim:,
+        alpha: nil, sigma: nil,
+        iterations: nil
+      )
+        super()
+        
+        raise ArgumentError, "X must be a positive integer" unless x.is_a?(Integer) && x > 0
+        @x = x
+
+        raise ArgumentError, "Y must be a positive integer" unless y.is_a?(Integer) && y > 0
+        @y = y
+
+        raise ArgumentError, "Dimension must be a positive integer" unless dim.is_a?(Integer) && dim > 0
+        @dim = dim
+
+        unless alpha.nil? or alpha.is_a?(Descent::Base)
+          raise ArgumentError, "alpha(t) must be a Descent::Base subclass"
+        end
+        
+        unless sigma.nil? or sigma.is_a?(Descent::Base)
+          raise ArgumentError, "sigma(t) must be a Descent::Base subclass"
+        end
+        
+        if iterations.nil? && (alpha.nil? or sigma.nil?)
+          raise ArgumentError, "Iterations number must be provided if no alpha(t) or sigma(t) given"
+        end
+
+        if iterations && (alpha or sigma)
+          raise ArgumentError, "Steps must not be provided if alpha(t) or sigma(t) given"
+        end
+
+        if alpha&.iterations && sigma&.iterations && alpha.iterations != sigma.iterations
+          raise ArgumentError, "alpha(t) and sigma(t) are designed for different iterations count"
+        end
+
+        @steps = alpha&.iterations || sigma&.iterations || iterations
+
+        @alpha_t = alpha || Descent::Monotonic.new(initial: 0.25, iterations: @steps)
+        @sigma_t = sigma || Descent::Monotonic.new(initial: [@x, @y].max / 2.0, iterations: @steps)
+
+        @weights = Torch.rand(@x * @y, @dim)
+        @meter = Torch::NN::PairwiseDistance.new
+
+        @node_coordinates = Torch.tensor(@x.times.to_a.product(@y.times.to_a), dtype: :long)
+      end
+
+      def forward(x, step_number = nil)
+        x = tensor!(x)
+        input = Torch.stack(Array.new(@x * @y) { x })
+        
+        bmu_1d_index = @meter.(input, @weights).argmin(dim: 0).item
+        bmu_2d_index = Torch.tensor([bmu_1d_index.div(@y), bmu_1d_index % @y])
+        
+        alpha = @alpha_t.(step_number)
+        sigma = @sigma_t.(step_number)
+
+        dists = Torch.stack(Array.new(@x * @y) { bmu_2d_index }) - @node_coordinates
+        sq_dists = (dists * dists).sum(dim: 1)
+        
+        h = (sq_dists / 2.0 / sigma / sigma).neg.exp * alpha
+
+        delta = Torch.einsum 'ij,i->ij', [input - @weights, h]
+        @weights += delta
+      end
+
+      def locations_for(vectors)
+        vectors.map do |x|
+          bmu_1d_index = @meter.(tensor!(x), @weights).argmin(dim: 0).item
+          [bmu_1d_index.div(@y), bmu_1d_index % @y]
+        end
+      end
+
+      def fit(vectors, progress: [:itself])
+        @steps.times.public_send(*progress).each do |i|
+          vectors.each do |x|
+            forward x, i
+          end
+        end
+        
+        locations_for vectors
+      end
+
+      def weights_2d
+        @weights.view(@x, @y, @dim)
+      end
+
+      private
+      def tensor!(x)
+        x.is_a?(Tensor) ? x : Torch.tensor(x)
+      end
+    end
+    
+    SOM = SelfOrganizedMap
+  end
+end

data/torch-som.gemspec

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative "lib/torch/som/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "torch-som"
+  spec.version       = Torch::NN::SelfOrganizedMap::VERSION
+  spec.authors       = ["Ivan Razuvaev"]
+  spec.email         = ["team@orlando-labs.com"]
+
+  spec.summary       = "Self-Organized Map implementation using torch-rb"
+  spec.description   = "Self-Organized Map implementation using torch-rb"
+  spec.homepage      = "https://github.com/orlando-labs/torch-som"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+#  spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "torch-rb", "~> 0.8.0"
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: torch-som
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ivan Razuvaev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-10-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: torch-rb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+description: Self-Organized Map implementation using torch-rb
+email:
+- team@orlando-labs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- example.rb
+- lib/torch/som.rb
+- lib/torch/som/descent/base.rb
+- lib/torch/som/descent/monotonic.rb
+- lib/torch/som/version.rb
+- torch-som.gemspec
+homepage: https://github.com/orlando-labs/torch-som
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/orlando-labs/torch-som
+  source_code_uri: https://github.com/orlando-labs/torch-som
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key: 
+specification_version: 4
+summary: Self-Organized Map implementation using torch-rb
+test_files: []