rumale-torch 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ec07a29a0bfa24f06e95a9cd8ca4e80eb61ffcb80d66caa2fc29b9f288bbb70
-  data.tar.gz: 4831243f51051c809c73d090424341fffec4b194f9f6e8fb83e648ab5ba4619e
+  metadata.gz: 42a236e4bcb36616d0ae30c45848786a6765c1c143ccd33c6b1674a960eabedb
+  data.tar.gz: 4cb6612a18e0d80027dce99feeb60e1af10eda8fde28d53570e258ce86031ecc
 SHA512:
-  metadata.gz: 053ed2b73a9edb5bb44631ed815555ca9bea25dab6de0edaa88bbd3358de07ea488d9c830ed083a99cb62007691512beb8cf68b0380fa440ecdfd22d5c1457c6
-  data.tar.gz: 1c483667b49e6bab0d2bd9cf8665b1f5d1f2e7a58f3e70b01800f50dc89d98b3cedd03ad30cb59c441c4c8bb355d63556863bb238081e304e20dfc15cd2d478c
+  metadata.gz: 5752fcc6806297cbc3cf2157414aba1c9d7c284a5cecb86b447419a01c0122acf1a44341099505bfa5f1cf676489f6a8bb541acdad542b2739867b0b09a6315a
+  data.tar.gz: 13a317eac5078834e3a2d046561ca6b1cde0ab5cd8c802dec0f070aa47f2538dae3b970a48753fd9b3271228a9fb5dcdf8b7300c07f119e599a0a7be0598e5b6

data/CHANGELOG.md

@@ -1,2 +1,9 @@
+# 0.2.0
+- Refactor to support the new Rumale API.
+
+# 0.1.1
+- Refator codes and config files.
+- Introduce commitlint and rubocop.
+
 # 0.1.0
 - First release.

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2020 Atsushi Tatsuma
+Copyright (c) 2020-2023 Atsushi Tatsuma
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

data/README.md

@@ -3,7 +3,7 @@
 [![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/)
+[![Documentation](https://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).
@@ -211,12 +211,10 @@ $ ruby cv.rb
 
 ## 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).
+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 [Contributor Covenant](https://contributor-covenant.org) code of conduct.
 
 ## 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/lib/rumale/torch/neural_net_classifier.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'rumale/base/base_estimator'
+require 'rumale/base/estimator'
 require 'rumale/base/classifier'
 require 'rumale/preprocessing/label_encoder'
 require 'rumale/model_selection/function'
@@ -38,9 +38,8 @@ module Rumale
     #
     #   classifier.predict(x)
     #
-    class NeuralNetClassifier
-      include Base::BaseEstimator
-      include Base::Classifier
+    class NeuralNetClassifier < Rumale::Base::Estimator
+      include Rumale::Base::Classifier
 
       # Return the class labels.
       # @return [Numo::Int32] (size: n_classes)
@@ -80,6 +79,7 @@ module Rumale
       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)
+        super()
         @model = model
         @device = device || ::Torch.device('cpu')
         @optimizer = optimizer || ::Torch::Optim::Adam.new(model.parameters)
@@ -193,9 +193,13 @@ module Rumale
 
       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)))
+          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)))
+          # rubocop:disable Layout/LineLength
+          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)))
+          # rubocop:enable Layout/LineLength
         end
       end
 

data/lib/rumale/torch/neural_net_regressor.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'rumale/base/base_estimator'
+require 'rumale/base/estimator'
 require 'rumale/base/regressor'
 require 'rumale/model_selection/shuffle_split'
 
@@ -36,9 +36,8 @@ module Rumale
     #
     #   regressor.predict(x)
     #
-    class NeuralNetRegressor
-      include Base::BaseEstimator
-      include Base::Regressor
+    class NeuralNetRegressor < Rumale::Base::Estimator
+      include Rumale::Base::Regressor
 
       # Return the neural nets defined with torch.rb.
       # @return [Torch::NN::Module]
@@ -74,6 +73,7 @@ module Rumale
       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)
+        super()
         @model = model
         @device = device || ::Torch.device('cpu')
         @optimizer = optimizer || ::Torch::Optim::Adam.new(model.parameters)
@@ -182,7 +182,8 @@ module Rumale
         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)))
+          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
 

data/lib/rumale/torch/version.rb

@@ -6,6 +6,6 @@ module Rumale
   # 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'
+    VERSION = '0.2.0'
   end
 end

metadata

@@ -1,29 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: rumale-torch
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - yoshoku
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-29 00:00:00.000000000 Z
+date: 2023-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rumale
+  name: rumale-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.24'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.24'
+- !ruby/object:Gem::Dependency
+  name: rumale-model_selection
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.24'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.24'
+- !ruby/object:Gem::Dependency
+  name: rumale-preprocessing
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.24'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.24'
 - !ruby/object:Gem::Dependency
   name: torch-rb
   requirement: !ruby/object:Gem::Requirement
@@ -38,28 +66,23 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Rumale::Torch provides the learning and inference by the neural network
+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
@@ -68,7 +91,8 @@ metadata:
   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: 
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -83,8 +107,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.3.26
+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

data/.github/workflows/build.yml

@@ -1,33 +0,0 @@
-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

@@ -1,18 +0,0 @@
-/.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

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

data/CODE_OF_CONDUCT.md

@@ -1,84 +0,0 @@
-# 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

@@ -1,10 +0,0 @@
-# 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/Rakefile

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

data/rumale-torch.gemspec

@@ -1,32 +0,0 @@
-# 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