torchrec 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b20b0c478258d789f1b6a6b2f80e3350600b6ce23f6ee1146cfb6819551a1150
+  data.tar.gz: 443383a994cd25d6225f84401e0a47886b848e590551ae0eec2eb31dba9468bd
+SHA512:
+  metadata.gz: a8e6ce693978cd21505f4b7378efe92a87ee672ece2d012cf3ee69dc9a3a3332cc57a84d1e0edcc7c317385aaae212a8351e54d5ea33ad338f795ec7138c5cdc
+  data.tar.gz: eb105de85d924fd2d3c7ef444a61caecdfb8008a5f25dba7297bb233b04f2662a47e144305301bd60f6cc1e9734bb1551946911047e8f654581b5fb192330cf2

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.0.1 (2022-02-28)
+
+- First release

data/LICENSE.txt

@@ -0,0 +1,30 @@
+BSD 3-Clause License
+
+Copyright (c) Meta Platforms, Inc. and affiliates.
+Copyright (c) Andrew Kane.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,62 @@
+# TorchRec Ruby
+
+Deep learning recommendation systems for Ruby
+
+[![Build Status](https://github.com/ankane/torchrec-ruby/workflows/build/badge.svg?branch=master)](https://github.com/ankane/torchrec-ruby/actions)
+
+## Installation
+
+Add this line to your application’s Gemfile:
+
+```ruby
+gem "torchrec"
+```
+
+## Getting Started
+
+This library follows the [Python API](https://pytorch.org/torchrec/). Many methods and options are missing at the moment. PRs welcome!
+
+## Models
+
+DeepFM
+
+```ruby
+TorchRec::Models::DeepFM::DenseArch.new(in_features, hidden_layer_size, embedding_dim)
+TorchRec::Models::DeepFM::OverArch.new(in_features)
+```
+
+DLRM
+
+```ruby
+TorchRec::Models::DLRM::DenseArch.new(in_features, layer_sizes, device: nil)
+```
+
+## Modules
+
+```ruby
+TorchRec::Modules::Activation::SwishLayerNorm.new(input_dims, device: nil)
+TorchRec::Modules::MLP::MLP.new(in_size, layer_sizes, bias: true, activation: :relu, device: nil)
+TorchRec::Modules::MLP::Perceptron.new(in_size, out_size, bias: true, activation: Torch.method(:relu), device: nil)
+```
+
+## History
+
+View the [changelog](https://github.com/ankane/torchrec-ruby/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/torchrec-ruby/issues)
+- Fix bugs and [submit pull requests](https://github.com/ankane/torchrec-ruby/pulls)
+- Write, clarify, or fix documentation
+- Suggest or add new features
+
+To get started with development:
+
+```sh
+git clone https://github.com/ankane/torchrec-ruby.git
+cd torchrec-ruby
+bundle install
+bundle exec rake test
+```

data/lib/torchrec/models/deepfm/dense_arch.rb

@@ -0,0 +1,21 @@
+module TorchRec
+  module Models
+    module DeepFM
+      class DenseArch < Torch::NN::Module
+        def initialize(in_features, hidden_layer_size, embedding_dim)
+          super()
+          @model = Torch::NN::Sequential.new(
+            Torch::NN::Linear.new(in_features, hidden_layer_size),
+            Torch::NN::ReLU.new,
+            Torch::NN::Linear.new(hidden_layer_size, embedding_dim),
+            Torch::NN::ReLU.new
+          )
+        end
+
+        def forward(features)
+          @model.call(features)
+        end
+      end
+    end
+  end
+end

data/lib/torchrec/models/deepfm/over_arch.rb

@@ -0,0 +1,19 @@
+module TorchRec
+  module Models
+    module DeepFM
+      class OverArch < Torch::NN::Module
+        def initialize(in_features)
+          super()
+          @model = Torch::NN::Sequential.new(
+            Torch::NN::Linear.new(in_features, 1),
+            Torch::NN::Sigmoid.new
+          )
+        end
+
+        def forward(features)
+          @model.call(features)
+        end
+      end
+    end
+  end
+end

data/lib/torchrec/models/dlrm/dense_arch.rb

@@ -0,0 +1,18 @@
+module TorchRec
+  module Models
+    module DLRM
+      class DenseArch < Torch::NN::Module
+        def initialize(in_features, layer_sizes, device: nil)
+          super()
+          @model = Modules::MLP::MLP.new(
+            in_features, layer_sizes, bias: true, activation: :relu, device: device
+          )
+        end
+
+        def forward(features)
+          @model.call(features)
+        end
+      end
+    end
+  end
+end

data/lib/torchrec/modules/activation/swish_layer_norm.rb

@@ -0,0 +1,20 @@
+module TorchRec
+  module Modules
+    module Activation
+      class SwishLayerNorm < Torch::NN::Module
+        def initialize(input_dims, device: nil)
+          super()
+          @norm = Torch::NN::Sequential.new(
+            # TODO add device
+            Torch::NN::LayerNorm.new(input_dims), #, device: device),
+            Torch::NN::Sigmoid.new
+          )
+        end
+
+        def forward(input)
+          input * @norm.call(input)
+        end
+      end
+    end
+  end
+end

data/lib/torchrec/modules/mlp/mlp.rb

@@ -0,0 +1,51 @@
+module TorchRec
+  module Modules
+    module MLP
+      class MLP < Torch::NN::Module
+        def initialize(in_size, layer_sizes, bias: true, activation: :relu, device: nil)
+          super()
+
+          if activation == :relu
+            activation = Torch.method(:relu)
+          elsif activation == :sigmoid
+            activation = Torch.method(:sigmoid)
+          end
+
+          if !activation.is_a?(Symbol)
+            @mlp = Torch::NN::Sequential.new(
+              *layer_sizes.length.times.map do |i|
+                Perceptron.new(
+                  i > 0 ? layer_sizes[i - 1] : in_size,
+                  layer_sizes[i],
+                  bias: bias,
+                  activation: Utils.extract_module_or_tensor_callable(activation),
+                  device: device
+                )
+              end
+            )
+          else
+            if activation == :swish_layernorm
+              @mlp = Torch::NN::Sequential.new(
+                *layer_sizes.length.times.map do |i|
+                  Perceptron.new(
+                    i > 0 ? layer_sizes[i - 1] : in_size,
+                    layer_sizes[i],
+                    bias: bias,
+                    activation: Activation::SwishLayerNorm.new(layer_sizes[i], device: device),
+                    device: device
+                  )
+                end
+              )
+            else
+              raise ArgumentError, "This MLP only supports activation function of :relu, :sigmoid, and :swish_layernorm"
+            end
+          end
+        end
+
+        def forward(input)
+          @mlp.call(input)
+        end
+      end
+    end
+  end
+end

data/lib/torchrec/modules/mlp/perceptron.rb

@@ -0,0 +1,22 @@
+module TorchRec
+  module Modules
+    module MLP
+      class Perceptron < Torch::NN::Module
+        def initialize(in_size, out_size, bias: true, activation: Torch.method(:relu), device: nil)
+          super()
+          @out_size = out_size
+          @in_size = in_size
+          @linear = Torch::NN::Linear.new(
+            # TODO add device
+            @in_size, @out_size, bias: bias #, device: device
+          )
+          @activation_fn = activation
+        end
+
+        def forward(input)
+          @activation_fn.call(@linear.call(input))
+        end
+      end
+    end
+  end
+end

data/lib/torchrec/modules/utils.rb

@@ -0,0 +1,12 @@
+module TorchRec
+  module Modules
+    module Utils
+      class << self
+        # TODO
+        def extract_module_or_tensor_callable(module_or_callable)
+          module_or_callable
+        end
+      end
+    end
+  end
+end

data/lib/torchrec/version.rb

@@ -0,0 +1,3 @@
+module TorchRec
+  VERSION = "0.0.1"
+end

data/lib/torchrec.rb

@@ -0,0 +1,20 @@
+# dependencies
+require "torch"
+
+# models
+require "torchrec/models/deepfm/dense_arch"
+require "torchrec/models/deepfm/over_arch"
+require "torchrec/models/dlrm/dense_arch"
+
+# modules
+require "torchrec/modules/activation/swish_layer_norm"
+require "torchrec/modules/mlp/mlp"
+require "torchrec/modules/mlp/perceptron"
+require "torchrec/modules/utils"
+
+# other
+require "torchrec/version"
+
+module TorchRec
+  class Error < StandardError; end
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: torchrec
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andrew Kane
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-02-28 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email: andrew@ankane.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/torchrec.rb
+- lib/torchrec/models/deepfm/dense_arch.rb
+- lib/torchrec/models/deepfm/over_arch.rb
+- lib/torchrec/models/dlrm/dense_arch.rb
+- lib/torchrec/modules/activation/swish_layer_norm.rb
+- lib/torchrec/modules/mlp/mlp.rb
+- lib/torchrec/modules/mlp/perceptron.rb
+- lib/torchrec/modules/utils.rb
+- lib/torchrec/version.rb
+homepage: https://github.com/ankane/torchrec-ruby
+licenses:
+- BSD-3-Clause
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key:
+specification_version: 4
+summary: Deep learning recommendation systems for Ruby
+test_files: []