see5 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f2f7b552c03f5df7d375e4fdf2af7a30bbd25cd4c55634a5be14b5abd0f511f2
-  data.tar.gz: 03056357c74c6cd58145c5a60f9a759b2f8c04fb7809357163900415da1a1791
+  metadata.gz: a953b6bf5aafae7ae110f261e525e7b2421c39f517c56c885af0560ea0d7a3ec
+  data.tar.gz: 64e7f538405524d8fb5f900cd62a2acea92d42e38053f1ef527cd0108e448dc8
 SHA512:
-  metadata.gz: dd9b563564b17b5b9f2f770448b59ed75947b0ad61fc26377529fed84cca56f5ac31f2b8950635a1a53bd8667d289d19a2cd5cedc2a2783c04b1f485d27cfcfc
-  data.tar.gz: f5b0be6ae50abef89eab752f4008b454a49b00f68bc59bff54a99adcc6968950fc898f43785eca0ee3c4915f75616edbae5c77fd953953a27156976cb51f7206
+  metadata.gz: 5b810bee1a216f3dd935d04e51287463b4a1e6b0b5186daf93c54140b9b02253dd14416617521800cca559925b4b09fd3bfa62b6ee955a76776b3e138596348f
+  data.tar.gz: f99d05053a2cc441a0efc1c49010c3880d577ded61dfadaee2f89caddc356082d35227eabf77c20af419b487c08a6c5c13536bca9036f2c172f51c9512797b34

data/Gemfile.lock

@@ -1,22 +1,22 @@
 PATH
   remote: .
   specs:
-    see5 (0.1.0)
+    see5 (0.2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    minitest (5.14.1)
+    minitest (5.14.4)
     rake (13.0.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.17)
+  bundler (~> 2.0)
   minitest (~> 5.0)
   rake (~> 13.0)
   see5!
 
 BUNDLED WITH
-   1.17.2
+   2.2.15

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020-2021 Eddie Lebow <elebow@users.noreply.github.com>
+
+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

@@ -1,4 +1,4 @@
-# Ruby::See5
+# See5
 
 A Ruby frontend for the See5/C5.0 family of classifiers and modellers. Builds models from Ruby objects.
 
@@ -7,27 +7,91 @@ A Ruby frontend for the See5/C5.0 family of classifiers and modellers. Builds mo
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'ruby-see5'
+gem 'see5'
 ```
 
 And then execute:
 
-    $ bundle
+```
+bundle
+```
 
 Or install it yourself as:
 
-    $ gem install ruby-see5
+```
+gem install see5
+```
+
+You may also wish to install the gem `see5-installer` to provide the required executables: <https://github.com/elebow/ruby-see5-installer>.
 
 ## Usage
 
-TODO: Write usage instructions here
+### Training a classifier
+
+The gem `see5-installer` must be installed, or `c5.0` must be available in the system path.
+
+Input data must be an Enumerable of Hashes, OpenStructs, or ActiveModel-like objects—anything that responds to `#[]` or `#send(:attr_name)` for each attribute name.
+
+The objects must respond to `#each` for automatic schema construction; otherwise, you will have to specify the schema.
+
+```ruby
+data = [
+  { a: true, b: 5, c: "yellow" },
+  { a: false, b: 6, c: "green" },
+  # ...
+]
+```
+
+Train a classifier by calling `See5.train`. Pass in the data and the name of the class attribute.
+
+```ruby
+classifier = See5.train(data, class_attribute: :a)
+```
+
+Use the model to classify new records by calling `#classify`.
+
+```ruby
+classifier.classify(b: 5)
+# => true
+
+classifier.classify(b: 8, c: "green")
+# => false
+```
+
+Inspect the classifier's rules with `#rules`.
+
+```ruby
+classifier.rules
+```
 
-## Development
+### Dumping and loading a classifier
+
+A model can be dumped to JSON, to be loaded and used later. Perhaps you want to run the classifier in a production system.
+
+Loading and using a classifier does not have any dependencies outside the gem.
+
+```ruby
+File.write("classifier.json", classifier.to_json)
+```
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+Load a classifier from a JSON string.
+
+```ruby
+classifier = See5::Model.from_json(json_string)
+```
+
+### Anomaly detection with GritBot
+
+Anomaly detection uses the same input format as training a model. Call `See5.audit` to detect anomalies in the set.
+
+The gem `see5-installer` must be installed, or `gritbot` must be available in the system path.
+
+```ruby
+anomalies = See5.audit(data, class_attribute: :a)
+```
 
-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).
+Anomalies are hashes.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/elebow/ruby-see5.
+Bug reports and pull requests are welcome on GitHub at <https://github.com/elebow/ruby-see5>.

data/lib/see5.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "bundler"
+
 require "see5/input_file_writer"
 require "see5/model"
 require "see5/rules_output_parser"
@@ -8,8 +10,8 @@ require "see5/schema"
 require "see5/version"
 
 module See5
-  def self.train(data, class_attribute)
-    prepare_tmp_files(data, class_attribute)
+  def self.train(data, class_attribute:)
+    prepare_tmp_files(data, class_attribute: class_attribute)
     run_see5
 
     output = See5::RulesOutputParser.parse_file("/tmp/ruby-see5.rules_output")
@@ -17,23 +19,37 @@ module See5
     See5::Model.new(**output)
   end
 
-  def self.audit(data, class_attribute)
-    prepare_tmp_files(data, class_attribute)
+  def self.audit(data, class_attribute:)
+    prepare_tmp_files(data, class_attribute: class_attribute)
     run_gritbot
 
     See5::GritbotOutputParser.parse_file("/tmp/ruby-see5.gritbot_output")
   end
 
-  def self.prepare_tmp_files(data, class_attribute)
-    schema = See5::Schema.from_dataset(data, class_attribute)
+  def self.prepare_tmp_files(data, class_attribute:)
+    schema = See5::Schema.from_dataset(data, class_attribute: class_attribute)
     See5::InputFileWriter.write_files(data: data, schema: schema)
   end
 
   def self.run_see5
-    system("c5.0 -f /tmp/ruby-see5 -r > /tmp/ruby-see5.rules_output")
+    system("#{see5_executable} -f /tmp/ruby-see5 -r > /tmp/ruby-see5.rules_output")
   end
 
   def self.run_gritbot
-    system("gritbot -s -f /tmp/ruby-see5 -r > /tmp/ruby-see5.gritbot_output")
+    system("#{gritbot_executable} -s -f /tmp/ruby-see5 -r > /tmp/ruby-see5.gritbot_output")
+  end
+
+  private
+
+  private_class_method def self.see5_executable
+    @see5_executable ||= see5_installer_path ? "#{see5_installer_path}/ext/c5.0/c5.0" : "c5.0"
+  end
+
+  private_class_method def self.gritbot_executable
+    @gritbot_executable ||= see5_installer_path ? "#{see5_installer_path}/ext/gritbot/gritbot" : "gritbot"
+  end
+
+  private_class_method def self.see5_installer_path
+    @see5_installer_path ||= Bundler.rubygems.find_name("see5-installer").first&.full_gem_path
   end
 end

data/lib/see5/model.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "json"
+
 module See5
   class Model
     attr_reader :rules
@@ -18,5 +20,20 @@ module See5
 
       @default_classification
     end
+
+    def to_h
+      { default_classification: @default_classification,
+        rules: rules.map(&:to_h) }
+    end
+
+    def to_json
+      to_h.to_json
+    end
+
+    def self.from_json(json)
+      json_hash = JSON.parse(json, symbolize_names: true)
+      new(default_classification: json_hash[:default_classification],
+          rules: json_hash[:rules]&.map { |rule_hash| Rule.from_h(rule_hash) })
+    end
   end
 end

data/lib/see5/rule.rb

@@ -17,11 +17,25 @@ module See5
         .all? { |matched| matched == true }
     end
 
+    def to_h
+      { rule_info: rule_info,
+        conditions: conditions,
+        classification: classification,
+        confidence: confidence }
+    end
+
+    def self.from_h(h)
+      new(h[:rule_info],
+          h[:conditions],
+          { classification: h[:classification],
+            confidence: h[:confidence] })
+    end
+
     def to_s
       [
         "See5::Rule",
-        "@classification=#{@classification}",
-        "@conditions=#{@conditions}"
+        "@classification=#{classification}",
+        "@conditions=#{conditions}"
       ]
         .join(", ")
         .yield_self { |s| "#<#{s}>" }

data/lib/see5/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module See5
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/see5.gemspec

@@ -13,6 +13,7 @@ Gem::Specification.new do |spec|
   spec.summary       = "A Ruby frontend for the See5/C5.0 family of classifiers and modellers."
   #spec.description   = "TODO: Write a longer description or delete this line."
   spec.homepage      = "https://github.com/elebow/ruby-see5"
+  spec.license       = "MIT"
 
   if spec.respond_to?(:metadata)
     spec.metadata["homepage_uri"] = spec.homepage
@@ -32,7 +33,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "minitest", "~> 5.0"
   spec.add_development_dependency "rake", "~> 13.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: see5
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Eddie Lebow
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-27 00:00:00.000000000 Z
+date: 2021-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -63,6 +63,7 @@ files:
 - ".rubocop.yml"
 - Gemfile
 - Gemfile.lock
+- LICENSE
 - README.md
 - Rakefile
 - lib/see5.rb
@@ -75,7 +76,8 @@ files:
 - lib/see5/version.rb
 - see5.gemspec
 homepage: https://github.com/elebow/ruby-see5
-licenses: []
+licenses:
+- MIT
 metadata:
   homepage_uri: https://github.com/elebow/ruby-see5
   source_code_uri: https://github.com/elebow/ruby-see5
@@ -95,7 +97,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project: 
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: A Ruby frontend for the See5/C5.0 family of classifiers and modellers.