rumale-torch 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0ec07a29a0bfa24f06e95a9cd8ca4e80eb61ffcb80d66caa2fc29b9f288bbb70
+  data.tar.gz: 4831243f51051c809c73d090424341fffec4b194f9f6e8fb83e648ab5ba4619e
+SHA512:
+  metadata.gz: 053ed2b73a9edb5bb44631ed815555ca9bea25dab6de0edaa88bbd3358de07ea488d9c830ed083a99cb62007691512beb8cf68b0380fa440ecdfd22d5c1457c6
+  data.tar.gz: 1c483667b49e6bab0d2bd9cf8665b1f5d1f2e7a58f3e70b01800f50dc89d98b3cedd03ad30cb59c441c4c8bb355d63556863bb238081e304e20dfc15cd2d478c

data/.github/workflows/build.yml

@@ -0,0 +1,33 @@
+name: build
+on: [push, pull_request]
+jobs:
+  build:
+    runs-on: ubuntu-20.04
+    strategy:
+      matrix:
+        ruby: [ '2.5', '2.6', '2.7' ]
+    env:
+      LIBTORCH_VERSION: 1.7.1
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby ${{ matrix.ruby }}
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - uses: actions/cache@v2
+        with:
+          path: ~/libtorch
+          key: libtorch-${{ env.LIBTORCH_VERSION }}
+        id: cache-libtorch
+      - name: Download LibTorch
+        if: steps.cache-libtorch.outputs.cache-hit != 'true'
+        run: |
+          cd ~
+          wget -q -O libtorch.zip https://download.pytorch.org/libtorch/cpu/libtorch-cxx11-abi-shared-with-deps-$LIBTORCH_VERSION%2Bcpu.zip
+          unzip -q libtorch.zip
+      - name: Build and test with Rake
+        run: |
+          gem install bundler
+          bundle config build.torch-rb --with-torch-dir=$HOME/libtorch
+          bundle install
+          bundle exec rake

data/.gitignore

@@ -0,0 +1,18 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.DS_Store
+.ruby-version
+tags
+Gemfile.lock
+*.swp
+*.bundle

data/.rspec

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

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+# 0.1.0
+- First release.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at yoshoku@outlook.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rumale-torch.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+gem 'rspec', '~> 3.0'
+gem 'simplecov', '~> 0.19'

data/LICENSE.txt

@@ -0,0 +1,27 @@
+Copyright (c) 2020 Atsushi Tatsuma
+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,222 @@
+# Rumale::Torch
+
+[![Build Status](https://github.com/yoshoku/rumale-torch/workflows/build/badge.svg)](https://github.com/yoshoku/rumale-torch/actions?query=workflow%3Abuild)
+[![Gem Version](https://badge.fury.io/rb/rumale-torch.svg)](https://badge.fury.io/rb/rumale-torch)
+[![BSD 3-Clause License](https://img.shields.io/badge/License-BSD%203--Clause-orange.svg)](https://github.com/yoshoku/rumale-torch/blob/main/LICENSE.txt)
+[![Documentation](http://img.shields.io/badge/api-reference-blue.svg)](https://yoshoku.github.io/rumale-torch/doc/)
+
+Rumale::Torch provides the learning and inference by the neural network defined in [torch.rb](https://github.com/ankane/torch.rb)
+with the same interface as [Rumale](https://github.com/yoshoku/rumale).
+
+## Installation
+torch.rb is a runtime dependent gem of Rumale::Torch. It requires to install [LibTorch](https://github.com/ankane/torch.rb#libtorch-installation):
+
+    $ brew install automake libtorch
+
+Here, automake is needed to install [rice](https://github.com/jasonroelofs/rice) gem, which torch.rb depends on.
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rumale-torch'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rumale-torch
+
+## Usage
+
+### Example 1. Pendigits dataset classification
+
+We start by downloading the pendigits dataset from [LIBSVM Data](https://www.csie.ntu.edu.tw/~cjlin/libsvmtools/datasets/) web site.
+
+```bash
+$ wget https://www.csie.ntu.edu.tw/~cjlin/libsvmtools/datasets/multiclass/pendigits
+$ wget https://www.csie.ntu.edu.tw/~cjlin/libsvmtools/datasets/multiclass/pendigits.t
+```
+
+Training phase:
+
+```ruby
+require 'rumale'
+require 'rumale/torch'
+
+Torch.manual_seed(1)
+device = Torch.device('cpu')
+
+# Loading pendigits dataset consisting of
+# 16-dimensional data divided into 10 classes.
+x, y = Rumale::Dataset.load_libsvm_file('pendigits')
+
+# Define a neural network in torch.rb framework.
+class MyNet < Torch::NN::Module
+  def initialize
+    super
+    @dropout = Torch::NN::Dropout.new(p: 0.5)
+    @fc1 = Torch::NN::Linear.new(16, 128)
+    @fc2 = Torch::NN::Linear.new(128, 10)
+  end
+
+  def forward(x)
+    x = @fc1.call(x)
+    x = Torch::NN::F.relu(x)
+    x = @dropout.call(x)
+    x = @fc2.call(x)
+    Torch::NN::F.softmax(x)
+  end
+end
+
+net = MyNet.new.to(device)
+
+# Create a classifier with neural network model.
+classifier = Rumale::Torch::NeuralNetClassifier.new(
+  model: net, device: device,
+  batch_size: 10, max_epoch: 50, validation_split: 0.1,
+  verbose: true
+)
+
+# Learning classifier.
+classifier.fit(x, y)
+
+# Saving model.
+Torch.save(net.state_dict, 'pendigits.pth')
+File.binwrite('pendigits.dat', Marshal.dump(classifier))
+```
+
+Testing phase:
+
+```ruby
+require 'rumale'
+require 'rumale/torch'
+
+# Loading neural network model.
+class MyNet < Torch::NN::Module
+  def initialize
+    super
+    @dropout = Torch::NN::Dropout.new(p: 0.5)
+    @fc1 = Torch::NN::Linear.new(16, 128)
+    @fc2 = Torch::NN::Linear.new(128, 10)
+  end
+
+  def forward(x)
+    x = @fc1.call(x)
+    x = Torch::NN::F.relu(x)
+    # x = @dropout.call(x)
+    x = @fc2.call(x)
+    Torch::NN::F.softmax(x)
+  end
+end
+
+net = MyNet.new
+net.load_state_dict(Torch.load('pendigits.pth'))
+
+# Loading classifier.
+classifier = Marshal.load(File.binread('pendigits.dat'))
+classifier.model = net
+
+# Loading test dataset.
+x_test, y_test = Rumale::Dataset.load_libsvm_file('pendigits.t')
+
+# Predict labels of test data.
+p_test = classifier.predict(x_test)
+
+# Evaluate predicted result.
+accuracy = Rumale::EvaluationMeasure::Accuracy.new.score(y_test, p_test)
+puts(format("Accuracy: %2.1f%%", accuracy * 100))
+```
+
+The result of executing the above scripts is as follows:
+
+```sh
+$ ruby train.rb
+epoch:  1/50 - loss: 0.2073 - accuracy: 0.3885 - val_loss: 0.2074 - val_accuracy: 0.3853
+epoch:  2/50 - loss: 0.1973 - accuracy: 0.4883 - val_loss: 0.1970 - val_accuracy: 0.4893
+epoch:  3/50 - loss: 0.1962 - accuracy: 0.4997 - val_loss: 0.1959 - val_accuracy: 0.5013
+
+...
+
+epoch: 50/50 - loss: 0.1542 - accuracy: 0.9199 - val_loss: 0.1531 - val_accuracy: 0.9293
+
+$ ruby test.rb
+Accuracy: 91.2%
+```
+
+### Example 2. Cross-validation with Rumale
+
+Perform 5-fold cross-validation for regression problem using the housing dataset.
+
+```sh
+$ wget https://www.csie.ntu.edu.tw/~cjlin/libsvmtools/datasets/regression/housing
+```
+
+The example script:
+
+```ruby
+require 'rumale'
+require 'rumale/torch'
+
+Torch.manual_seed(1)
+device = Torch.device('cpu')
+
+# Loading pendigits dataset consisting of
+# 13-dimensional data with single target variable.
+x, y = Rumale::Dataset.load_libsvm_file('housing')
+
+# Define a neural network in torch.rb framework.
+class MyNet < Torch::NN::Module
+  def initialize
+    super
+    @fc1 = Torch::NN::Linear.new(13, 128)
+    @fc2 = Torch::NN::Linear.new(128, 1)
+  end
+
+  def forward(x)
+    x = @fc1.call(x)
+    x = Torch::NN::F.relu(x)
+    x = @fc2.call(x)
+  end
+end
+
+net = MyNet.new.to(device)
+
+# Create a regressor with neural network model.
+regressor = Rumale::Torch::NeuralNetRegressor.new(
+  model: net, device: device, batch_size: 10, max_epoch: 100
+)
+
+# Create evaluation measure, splitting strategy, and cross validation.
+ev = Rumale::EvaluationMeasure::R2Score.new
+kf = Rumale::ModelSelection::ShuffleSplit.new(n_splits: 5, test_size: 0.1, random_seed: 1)
+cv = Rumale::ModelSelection::CrossValidation.new(estimator: regressor, splitter: kf, evaluator: ev)
+
+# Perform 5-cross validation.
+report = cv.perform(x, y)
+
+# Output result.
+mean_score = report[:test_score].sum / kf.n_splits
+puts(format("5-CV R2-score: %.3f", mean_score))
+```
+
+The execution result is as follows:
+
+```ruby
+$ ruby cv.rb
+5-CV R2-score: 0.755
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/yoshoku/rumale-torch. 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/yoshoku/rumale-torch/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [BSD-3-Clause License](https://opensource.org/licenses/BSD-3-Clause).
+
+## Code of Conduct
+
+Everyone interacting in the Rumale::Torch project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/yoshoku/rumale-torch/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/rumale/torch.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'torch'
+require 'numo/narray'
+
+require 'rumale/torch/version'
+require 'rumale/torch/neural_net_classifier'
+require 'rumale/torch/neural_net_regressor'

data/lib/rumale/torch/neural_net_classifier.rb

@@ -0,0 +1,223 @@
+# frozen_string_literal: true
+
+require 'rumale/base/base_estimator'
+require 'rumale/base/classifier'
+require 'rumale/preprocessing/label_encoder'
+require 'rumale/model_selection/function'
+
+module Rumale
+  module Torch
+    # NeuralNetClassifier is a class that provides learning and inference by the neural network defined in torch.rb
+    # with an interface similar to classifier of Rumale.
+    #
+    # @example
+    #   require 'rumale/torch'
+    #
+    #   class MyNet < Torch::NN::Module
+    #     def initialize
+    #       super
+    #       @dropout = Torch::NN::Dropout.new(p: 0.5)
+    #       @fc1 = Torch::NN::Linear.new(2, 8)
+    #       @fc2 = Torch::NN::Linear.new(8, 2)
+    #     end
+    #
+    #     def forward(x)
+    #       x = @fc1.call(x)
+    #       x = Torch::NN::F.relu(x)
+    #       x = @dropout.call(x)
+    #       x = @fc2.call(x)
+    #       Torch::NN::F.softmax(x)
+    #     end
+    #   end
+    #
+    #   device = Torch.device('gpu')
+    #   net = MyNet.new.to(device)
+    #
+    #   classifier = Rumale::Torch::NeuralNetClassifier.new(model: net, device: device, batch_size: 50, max_epoch: 10)
+    #   classifier.fit(x, y)
+    #
+    #   classifier.predict(x)
+    #
+    class NeuralNetClassifier
+      include Base::BaseEstimator
+      include Base::Classifier
+
+      # Return the class labels.
+      # @return [Numo::Int32] (size: n_classes)
+      attr_reader :classes
+
+      # Return the neural nets defined with torch.rb.
+      # @return [Torch::NN::Module]
+      attr_accessor :model
+
+      # Return the compute device.
+      # @return [Torch::Device]
+      attr_accessor :device
+
+      # Return the optimizer.
+      # @return [Torch::Optim]
+      attr_accessor :optimizer
+
+      # Return the loss function.
+      # @return [Torch::NN]
+      attr_accessor :loss
+
+      # Create a new classifier with neural nets defined by torch.rb.
+      #
+      # @param model [Torch::NN::Module] The neural nets defined with torch.rb.
+      # @param device [Torch::Device/Nil] The compute device to be used.
+      #   If nil is given, it to be set to Torch.device('cpu').
+      # @param optimizer [Torch::Optim/Nil] The optimizer to be used to optimize the model.
+      #   If nil is given, it to be set to Torch::Optim::Adam.
+      # @param loss [Torch:NN] The loss function to be used to optimize the model.
+      #   If nil is given, it to be set to Torch::NN::CrossEntropyLoss.
+      # @param batch_size [Integer] The number of samples per batch to load.
+      # @param max_epoch [Integer] The number of epochs to train the model.
+      # @param shuffle [Boolean] The flag indicating whether to shuffle the data at every epoch.
+      # @param validation_split [Float] The fraction of the training data to be used as validation data.
+      # @param verbose [Boolean] The flag indicating whether to output loss during epoch.
+      # @param random_seed [Integer/Nil] The seed value using to initialize the random generator for data splitting.
+      def initialize(model:, device: nil, optimizer: nil, loss: nil,
+                     batch_size: 128, max_epoch: 10, shuffle: true, validation_split: 0,
+                     verbose: false, random_seed: nil)
+        @model = model
+        @device = device || ::Torch.device('cpu')
+        @optimizer = optimizer || ::Torch::Optim::Adam.new(model.parameters)
+        @loss = loss || ::Torch::NN::CrossEntropyLoss.new
+        @params = {}
+        @params[:batch_size] = batch_size
+        @params[:max_epoch] = max_epoch
+        @params[:shuffle] = shuffle
+        @params[:validation_split] = validation_split
+        @params[:verbose] = verbose
+        @params[:random_seed] = random_seed || srand
+        define_parameter_accessors
+      end
+
+      # Fit the model with given training data.
+      #
+      # @param x [Numo::DFloat] (shape: [n_samples, n_features]) The training data to be used for fitting the model.
+      # @param y [Numo::Int32] (shape: [n_samples]) The labels to be used for fitting the model.
+      # @return [NeuralNetClassifier] The learned classifier itself.
+      def fit(x, y)
+        encoder = Rumale::Preprocessing::LabelEncoder.new
+        y_encoded = encoder.fit_transform(y)
+        @classes = Numo::NArray[*encoder.classes]
+
+        train_loader, test_loader = prepare_dataset(x, y_encoded)
+
+        model.children.each do |layer|
+          layer.reset_parameters if layer.class.method_defined?(:reset_parameters)
+        end
+
+        1.upto(max_epoch) do |epoch|
+          train(train_loader)
+          display_epoch(train_loader, test_loader, epoch) if verbose
+        end
+
+        self
+      end
+
+      # Predict class labels for samples.
+      #
+      # @param x [Numo::DFloat] (shape: [n_samples, n_features]) The samples to predict the labels.
+      # @return [Numo::Int32] (shape: [n_samples]) Predicted class label per sample.
+      def predict(x)
+        output = ::Torch.no_grad { model.call(::Torch.from_numo(x).to(:float32)) }
+        _, indices = ::Torch.max(output, 1)
+        @classes[indices.numo].dup
+      end
+
+      # Calculate confidence scores for samples.
+      #
+      # @param x [Numo::DFloat] (shape: [n_samples, n_features]) The samples to compute the scores.
+      # @return [Numo::DFloat] (shape: [n_samples, n_classes]) The confidence score per sample.
+      def decision_function(x)
+        Numo::DFloat.cast(::Torch.no_grad { model.call(::Torch.from_numo(x).to(:float32)) }.numo)
+      end
+
+      # @!visibility private
+      def marshal_dump
+        { classes: @classes, params: @params }
+      end
+
+      # @!visibility private
+      def marshal_load(obj)
+        @model = nil
+        @device = nil
+        @optimizer = nil
+        @loss = nil
+        @classes = obj[:classes]
+        @params = obj[:params]
+        define_parameter_accessors
+      end
+
+      private
+
+      def define_parameter_accessors
+        @params.each_key do |name|
+          self.class.send(:define_method, name) { @params[name] }
+          self.class.send(:private, name)
+        end
+      end
+
+      def prepare_dataset(x, y)
+        n_validations = (validation_split * x.shape[0]).ceil.to_i
+        return [torch_data_loader(x, y), nil] unless n_validations.positive?
+
+        x_train, x_test, y_train, y_test = Rumale::ModelSelection.train_test_split(
+          x, y, test_size: validation_split, stratify: true, random_seed: random_seed
+        )
+        [torch_data_loader(x_train, y_train), torch_data_loader(x_test, y_test)]
+      end
+
+      def torch_data_loader(x, y)
+        x_tensor = ::Torch.from_numo(x).to(:float32)
+        y_tensor = ::Torch.from_numo(y).to(:int64)
+        dataset = ::Torch::Utils::Data::TensorDataset.new(x_tensor, y_tensor)
+        ::Torch::Utils::Data::DataLoader.new(dataset, batch_size: batch_size, shuffle: shuffle)
+      end
+
+      def train(data_loader)
+        model.train
+        data_loader.each_with_index do |(data, target), _batch_idx|
+          data = data.to(device)
+          target = target.to(device)
+          optimizer.zero_grad
+          output = model.call(data)
+          ls = loss.call(output, target)
+          ls.backward
+          optimizer.step
+        end
+      end
+
+      def display_epoch(train_loader, test_loader, epoch)
+        if test_loader.nil?
+          puts(format("epoch: %#{max_epoch.to_s.length}d/#{max_epoch} - loss: %.4f - accuracy: %.4f", epoch, *evaluate(train_loader)))
+        else
+          puts(format("epoch: %#{max_epoch.to_s.length}d/#{max_epoch} - loss: %.4f - accuracy: %.4f - val_loss: %.4f - val_accuracy: %.4f", epoch, *evaluate(train_loader), *evaluate(test_loader)))
+        end
+      end
+
+      def evaluate(data_loader)
+        model.eval
+        mean_loss = 0
+        correct = 0
+        ::Torch.no_grad do
+          data_loader.each do |data, target|
+            data = data.to(device)
+            target = target.to(device)
+            output = model.call(data)
+            mean_loss += loss.call(output, target).item
+            pred = output.argmax(1, keepdim: true).view(-1)
+            correct += pred.eq(target.view_as(pred)).sum.item
+          end
+        end
+
+        mean_loss /= data_loader.dataset.size
+        accuracy = correct.fdiv(data_loader.dataset.size)
+        [mean_loss, accuracy]
+      end
+    end
+  end
+end

data/lib/rumale/torch/neural_net_regressor.rb

@@ -0,0 +1,205 @@
+# frozen_string_literal: true
+
+require 'rumale/base/base_estimator'
+require 'rumale/base/regressor'
+require 'rumale/model_selection/shuffle_split'
+
+module Rumale
+  module Torch
+    # NeuralNetRegressor is a class that provides learning and inference by the neural network defined in torch.rb
+    # with an interface similar to regressor of Rumale.
+    #
+    # @example
+    #   require 'rumale/torch'
+    #
+    #   class MyNet < Torch::NN::Module
+    #     def initialize
+    #       super
+    #       @dropout = Torch::NN::Dropout.new(p: 0.5)
+    #       @fc1 = Torch::NN::Linear.new(2, 64)
+    #       @fc2 = Torch::NN::Linear.new(64, 1)
+    #     end
+    #
+    #     def forward(x)
+    #       x = @fc1.call(x)
+    #       x = Torch::NN::F.relu(x)
+    #       x = @dropout.call(x)
+    #       @fc2.call(x)
+    #     end
+    #   end
+    #
+    #   device = Torch.device('gpu')
+    #   net = MyNet.new.to(device)
+    #
+    #   regressor = Rumale::Torch::NeuralNetRegressor.new(model: net, device: device, batch_size: 50, max_epoch: 10)
+    #   regressor.fit(x, y)
+    #
+    #   regressor.predict(x)
+    #
+    class NeuralNetRegressor
+      include Base::BaseEstimator
+      include Base::Regressor
+
+      # Return the neural nets defined with torch.rb.
+      # @return [Torch::NN::Module]
+      attr_accessor :model
+
+      # Return the compute device.
+      # @return [Torch::Device]
+      attr_accessor :device
+
+      # Return the optimizer.
+      # @return [Torch::Optim]
+      attr_accessor :optimizer
+
+      # Return the loss function.
+      # @return [Torch::NN]
+      attr_accessor :loss
+
+      # Create a new regressor with neural nets defined by torch.rb.
+      #
+      # @param model [Torch::NN::Module] The neural nets defined with torch.rb.
+      # @param device [Torch::Device/Nil] The compute device to be used.
+      #   If nil is given, it to be set to Torch.device('cpu').
+      # @param optimizer [Torch::Optim/Nil] The optimizer to be used to optimize the model.
+      #   If nil is given, it to be set to Torch::Optim::Adam.
+      # @param loss [Torch:NN] The loss function to be used to optimize the model.
+      #   If nil is given, it to be set to Torch::NN::MSELoss.
+      # @param batch_size [Integer] The number of samples per batch to load.
+      # @param max_epoch [Integer] The number of epochs to train the model.
+      # @param shuffle [Boolean] The flag indicating whether to shuffle the data at every epoch.
+      # @param validation_split [Float] The fraction of the training data to be used as validation data.
+      # @param verbose [Boolean] The flag indicating whether to output loss during epoch.
+      # @param random_seed [Integer/Nil] The seed value using to initialize the random generator for data splitting.
+      def initialize(model:, device: nil, optimizer: nil, loss: nil,
+                     batch_size: 128, max_epoch: 10, shuffle: true, validation_split: 0,
+                     verbose: false, random_seed: nil)
+        @model = model
+        @device = device || ::Torch.device('cpu')
+        @optimizer = optimizer || ::Torch::Optim::Adam.new(model.parameters)
+        @loss = loss || ::Torch::NN::MSELoss.new
+        @params = {}
+        @params[:batch_size] = batch_size
+        @params[:max_epoch] = max_epoch
+        @params[:shuffle] = shuffle
+        @params[:validation_split] = validation_split
+        @params[:verbose] = verbose
+        @params[:random_seed] = random_seed || srand
+        define_parameter_accessors
+      end
+
+      # Fit the model with given training data.
+      #
+      # @param x [Numo::DFloat] (shape: [n_samples, n_features]) The training data to be used for fitting the model.
+      # @param y [Numo::DFloat] (shape: [n_samples, n_outputs]) The target values to be used for fitting the model.
+      # @return [NeuralNetRegressor] The learned regressor itself.
+      def fit(x, y)
+        y = y.expand_dims(1) if y.ndim == 1
+
+        train_loader, test_loader = prepare_dataset(x, y)
+
+        model.children.each do |layer|
+          layer.reset_parameters if layer.class.method_defined?(:reset_parameters)
+        end
+
+        1.upto(max_epoch) do |epoch|
+          train(train_loader)
+          display_epoch(train_loader, test_loader, epoch) if verbose
+        end
+
+        self
+      end
+
+      # Predict values for samples.
+      #
+      # @param x [Numo::DFloat] (shape: [n_samples, n_features]) The samples to predict the values.
+      # @return [Numo::DFloat] (shape: [n_samples, n_outputs]) The predicted values per sample.
+      def predict(x)
+        output = Numo::DFloat.cast(::Torch.no_grad { model.call(::Torch.from_numo(x).to(:float32)) }.numo)
+        output.shape[1] == 1 ? output[true, 0].dup : output
+      end
+
+      # @!visibility private
+      def marshal_dump
+        { params: @params }
+      end
+
+      # @!visibility private
+      def marshal_load(obj)
+        @model = nil
+        @device = nil
+        @optimizer = nil
+        @loss = nil
+        @params = obj[:params]
+        define_parameter_accessors
+      end
+
+      private
+
+      def define_parameter_accessors
+        @params.each_key do |name|
+          self.class.send(:define_method, name) { @params[name] }
+          self.class.send(:private, name)
+        end
+      end
+
+      def prepare_dataset(x, y)
+        n_validations = (validation_split * x.shape[0]).ceil.to_i
+        return [torch_data_loader(x, y), nil] unless n_validations.positive?
+
+        splitter = Rumale::ModelSelection::ShuffleSplit.new(
+          n_splits: 1, test_size: validation_split, random_seed: random_seed
+        )
+        train_ids, test_ids = splitter.split(x).first
+        x_train = x[train_ids, true]
+        x_test = x[test_ids, true]
+        y_train = y[train_ids, true]
+        y_test = y[test_ids, true]
+        [torch_data_loader(x_train, y_train), torch_data_loader(x_test, y_test)]
+      end
+
+      def torch_data_loader(x, y)
+        x_tensor = ::Torch.from_numo(x).to(:float32)
+        y_tensor = ::Torch.from_numo(y).to(:float32)
+        dataset = ::Torch::Utils::Data::TensorDataset.new(x_tensor, y_tensor)
+        ::Torch::Utils::Data::DataLoader.new(dataset, batch_size: batch_size, shuffle: shuffle)
+      end
+
+      def train(data_loader)
+        model.train
+        data_loader.each_with_index do |(data, target), _batch_idx|
+          data = data.to(device)
+          target = target.to(device)
+          optimizer.zero_grad
+          output = model.call(data)
+          ls = loss.call(output, target)
+          ls.backward
+          optimizer.step
+        end
+      end
+
+      def display_epoch(train_loader, test_loader, epoch)
+        if test_loader.nil?
+          puts(format("epoch: %#{max_epoch.to_s.length}d/#{max_epoch} - loss: %.4f", epoch, evaluate(train_loader)))
+        else
+          puts(format("epoch: %#{max_epoch.to_s.length}d/#{max_epoch} - loss: %.4f - val_loss: %.4f", epoch, evaluate(train_loader), evaluate(test_loader)))
+        end
+      end
+
+      def evaluate(data_loader)
+        model.eval
+        mean_loss = 0
+        ::Torch.no_grad do
+          data_loader.each do |data, target|
+            data = data.to(device)
+            target = target.to(device)
+            output = model.call(data)
+            mean_loss += loss.call(output, target).item
+          end
+        end
+
+        mean_loss / data_loader.dataset.size
+      end
+    end
+  end
+end

data/lib/rumale/torch/version.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+# Rumale is a machine learning library in Ruby.
+module Rumale
+  # Rumale::Torch provides the learning and inference function by
+  # the neural nets defined in torch.rb with the same interface as Rumale.
+  module Torch
+    # The version of Rumale::Torch you are using.
+    VERSION = '0.1.0'
+  end
+end

data/rumale-torch.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative 'lib/rumale/torch/version'
+
+Gem::Specification.new do |spec|
+  spec.name        = 'rumale-torch'
+  spec.version     = Rumale::Torch::VERSION
+  spec.authors     = ['yoshoku']
+  spec.email       = ['yoshoku@outlook.com']
+
+  spec.summary     = 'Rumale::Torch provides the learning and inference by the neural network defined in torch.rb with the same interface as Rumale'
+  spec.description = 'Rumale::Torch provides the learning and inference by the neural network defined in torch.rb with the same interface as Rumale'
+  spec.homepage    = 'https://github.com/yoshoku/rumale-torch'
+  spec.license     = 'BSD-3-Clause'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = 'https://github.com/yoshoku/rumale-torch/blob/main/CHANGELOG.md'
+  spec.metadata['documentation_uri'] = 'https://yoshoku.github.io/rumale-torch/doc/'
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'rumale'
+  spec.add_runtime_dependency 'torch-rb'
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: rumale-torch
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- yoshoku
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-12-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rumale
+  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: 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: Rumale::Torch provides the learning and inference by the neural network
+  defined in torch.rb with the same interface as Rumale
+email:
+- yoshoku@outlook.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/build.yml"
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rumale/torch.rb
+- lib/rumale/torch/neural_net_classifier.rb
+- lib/rumale/torch/neural_net_regressor.rb
+- lib/rumale/torch/version.rb
+- rumale-torch.gemspec
+homepage: https://github.com/yoshoku/rumale-torch
+licenses:
+- BSD-3-Clause
+metadata:
+  homepage_uri: https://github.com/yoshoku/rumale-torch
+  source_code_uri: https://github.com/yoshoku/rumale-torch
+  changelog_uri: https://github.com/yoshoku/rumale-torch/blob/main/CHANGELOG.md
+  documentation_uri: https://yoshoku.github.io/rumale-torch/doc/
+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: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Rumale::Torch provides the learning and inference by the neural network defined
+  in torch.rb with the same interface as Rumale
+test_files: []