knn_cv 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2c54dbd4962bb9a0663ea90098f5b6f0f3b53545
-  data.tar.gz: c0ac635518a8fffae07e3725471c717bfdfbf703
+  metadata.gz: 82ad55344b760f5b5fc48453c165ac225f943b5d
+  data.tar.gz: f95e098c3a20dae28375f3e61df444aa054daf33
 SHA512:
-  metadata.gz: b4f73c45e8d1d696fc791b30a8f3c5c9c99ac83a708446da9382058fd494d3cd89457b1aebe6937876934932f2935da2eca54af3cd36d94ed54b9401874f5d4c
-  data.tar.gz: 962ea49f993c4ead3db2684c79e90dd20939ad4ee48f53974bfe70919ac496a0d0b67fee1812b4c6a3f00a8c61507e48a22db11a5aa888cd04070aa1de88f5f1
+  metadata.gz: aeeba2a91ea65ec5ce46c68c6050ccaf67579b0ae80428b4b5484c7df2b0d035e76c6246b08ec3758babd4c48df41462c133faaaf231303ef8d6ce8579d38eb7
+  data.tar.gz: ea440252cf2b59f64671ffff77bd48df5544d66c4b691d77c5720ee84664e1e6f2ce5ad39ad3a8b4161dc4f49b7987199ef094f9b714c46d3c0ce1b384355c6c

data/README.md

@@ -1,8 +1,6 @@
 # KnnCv
 
-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/knn_cv`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+A native kNN leave-one-out technique implementation (oriented to feature selection) for Ruby based on the 'class' package for R.
 
 ## Installation
 
@@ -22,15 +20,22 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+This gem provides very basic functionality in a straight-forward manner. `Classifier` objects can be created in order to evaluate kNN several times:
 
-## Development
+```ruby
+knn = KnnCv::Classifier.new k, data, Random.new
+```
 
-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.
+where `k` represents the number of neighbors to be considered, `data` must be an `Array` of instances, which in turn are numeric `Array`s. The third argument is a `Random` object that can be used to ensure reproducibility.
 
-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).
+To evaluate the behavior of the classifier over certain features, use the `fitness_for` method:
 
-## Contributing
+```ruby
+knn.fitness_for [0, 1, 0, 0, 1, 0, 1, 1, 1]
+```
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/knn_cv.
+The argument must be a binary `Array` (or other type of object that converts to a binary `Array`, such as [`BitArray`](https://github.com/ingramj/bitarray)).
+
+## Contributing
 
+Bug reports and pull requests are welcome at https://github.com/fdavidcl/knn_cv.

data/knn_cv.gemspec

@@ -9,9 +9,10 @@ Gem::Specification.new do |spec|
   spec.authors       = ["David Charte"]
   spec.email         = ["fdavidcl@outlook.com"]
 
-  spec.summary       = %q{A native kNN leave-one-out technique implementation for Ruby based on the 'class' package for R}
-  spec.description   = %q{A native kNN leave-one-out technique implementation for Ruby based on the 'class' package for R}
+  spec.summary       = %q{A native kNN leave-one-out technique implementation}
+  spec.description   = %q{A native kNN leave-one-out technique implementation for Ruby based on the 'class' package for R.}
   spec.homepage      = "https://github.com/fdavidcl/ruby-knn_cv"
+  spec.licenses      = ["GPL-3.0+"]
 
   # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
   # delete this section to allow pushing this gem to any host.

data/lib/knn_cv/version.rb

@@ -1,3 +1,3 @@
 module KnnCv
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 end

data/lib/knn_cv.rb

@@ -1,7 +1,6 @@
 require "knn_cv/version"
 
 module KnnCv
-  # Your code goes here...
 end
 
 require "c_knn"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: knn_cv
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - David Charte
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: A native kNN leave-one-out technique implementation for Ruby based on
-  the 'class' package for R
+  the 'class' package for R.
 email:
 - fdavidcl@outlook.com
 executables: []
@@ -90,7 +90,8 @@ files:
 - lib/knn_cv.rb
 - lib/knn_cv/version.rb
 homepage: https://github.com/fdavidcl/ruby-knn_cv
-licenses: []
+licenses:
+- GPL-3.0+
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -111,6 +112,5 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: A native kNN leave-one-out technique implementation for Ruby based on the
-  'class' package for R
+summary: A native kNN leave-one-out technique implementation
 test_files: []