inferx 0.1.5 → 0.1.6

data/lib/inferx/adapter.rb

@@ -1,8 +1,8 @@
 class Inferx
   class Adapter
 
-    # @param [Redis] an instance of Redis
-    # @param [String] namespace of keys to be used to Redis
+    # @param [Redis] redis an instance of Redis
+    # @param [String] namespace namespace of keys to be used to Redis
     def initialize(redis, namespace = nil)
       @redis = redis
       @namespace = namespace
@@ -26,7 +26,7 @@ class Inferx
 
     # Make the key for access to scores stored each by word.
     #
-    # @param [Symbol] a category name
+    # @param [Symbol] category_name a category name
     # @return [String] the key
     def make_category_key(category_name)
       "#{categories_key}:#{category_name}"
@@ -34,8 +34,9 @@ class Inferx
 
     # Spawn an instance of any class.
     #
-    # @param [Class] any class, constructor takes the instance of Redis to
+    # @param [Class] klass any class, constructor takes the instance of Redis to
     #   first argument, and takes the namespace to last argument
+    # @param [Array] args any arguments
     # @return [Object] a instance of the class
     def spawn(klass, *args)
       klass.new(@redis, *args, @namespace)

data/lib/inferx/categories.rb

@@ -3,6 +3,7 @@ require 'inferx/category'
 
 class Inferx
   class Categories < Adapter
+    include Enumerable
 
     # Get all category names.
     #
@@ -11,9 +12,9 @@ class Inferx
       (hkeys || []).map(&:to_sym)
     end
 
-    # Get a category according name.
+    # Get a category according the name.
     #
-    # @param [Symbol] category name
+    # @param [Symbol] category_name category name
     # @return [Inferx::Category] category
     def get(category_name)
       raise ArgumentError, "'#{category_name}' is missing" unless hexists(category_name)
@@ -23,7 +24,7 @@ class Inferx
 
     # Add categories.
     #
-    # @param [Array<Symbol>] category names
+    # @param [Array<Symbol>] category_names category names
     def add(*category_names)
       @redis.pipelined do
         category_names.each { |category_name| hsetnx(category_name, 0) }
@@ -32,7 +33,7 @@ class Inferx
 
     # Remove categories.
     #
-    # @param [Array<Symbol>] category names
+    # @param [Array<Symbol>] category_names category names
     def remove(*category_names)
       @redis.pipelined do
         category_names.each { |category_name| hdel(category_name) }
@@ -40,12 +41,10 @@ class Inferx
       end
     end
 
-    include Enumerable
-
     # Apply process for each category.
     #
     # @yield a block to be called for every category
-    # @yieldparam [Inferx::Category] category
+    # @yieldparam [Inferx::Category] category category
     def each
       all.each { |category_name| yield spawn(Category, category_name) }
     end

data/lib/inferx/category.rb

@@ -3,22 +3,25 @@ require 'inferx/adapter'
 class Inferx
   class Category < Adapter
 
-    # @param [Redis] an instance of Redis
-    # @param [Symbol] a category name
-    # @param [String] namespace of keys to be used to Redis
+    # @param [Redis] redis an instance of Redis
+    # @param [Symbol] name a category name
+    # @param [String] namespace namespace of keys to be used to Redis
     def initialize(redis, name, namespace = nil)
       super(redis, namespace)
       @name = name
     end
 
+    # Get a category name.
+    #
+    # @attribute [r] name
+    # @return [Symbol] a category name
     attr_reader :name
 
     # Get words with scores in the category.
     #
     # @param [Hash] options
-    #   - `:score => Integer`: lower limit for getting by score
-    #   - `:rank  => Integer`: upper limit for getting by rank
-    #
+    # @option options [Integer] :score lower limit for getting by score
+    # @option options [Integer] :rank upper limit for getting by rank
     # @return [Hash<String, Integer>] words with scores
     def all(options = {})
       words_with_scores = if score = options[:score]
@@ -41,10 +44,9 @@ class Inferx
 
     # Get score of a word.
     #
-    # @param [String] a word
-    # @return [Integer, nil]
-    #   - when the word is member, score of the word
-    #   - when the word is not member, nil
+    # @param [String] word a word
+    # @return [Integer] when the word is member, score of the word
+    # @return [nil] when the word is not member
     def get(word)
       score = zscore(word)
       score ? score.to_i : nil
@@ -53,7 +55,7 @@ class Inferx
 
     # Enhance the training data giving words.
     #
-    # @param [Array<String>] words
+    # @param [Array<String>] words an array of words
     def train(words)
       @redis.pipelined do
         increase = collect(words).inject(0) do |count, pair|
@@ -67,7 +69,7 @@ class Inferx
 
     # Attenuate the training data giving words.
     #
-    # @param [Array<String>] words
+    # @param [Array<String>] words an array of words
     def untrain(words)
       decrease = 0
 
@@ -97,9 +99,9 @@ class Inferx
 
     # Get effectively scores for each word.
     #
-    # @param [Array<String>] words
-    # @param [Hash<String, Integer>] words with scores prepared in advance for
-    #   reduce access to Redis
+    # @param [Array<String>] words a set of words
+    # @param [Hash<String, Integer>] words_with_scores words with scores
+    #   prepared in advance for reduce access to Redis
     # @return [Array<Integer>] scores for each word
     def scores(words, words_with_scores = {})
       scores = @redis.pipelined do

data/lib/inferx/version.rb

@@ -1,3 +1,3 @@
 class Inferx
-  VERSION = '0.1.5'
+  VERSION = '0.1.6'
 end

data/lib/inferx.rb

@@ -5,11 +5,10 @@ require 'inferx/categories'
 
 class Inferx
 
-  # @param [Hash] options
-  #   - `:namespace => String`: namespace of keys to be used to Redis
+  # @param [Hash] options other options are passed to Redis#initialize in
+  #   {https://github.com/redis/redis-rb redis}
   #
-  #   Other options are passed to Redis#initialize in:
-  #     https://github.com/redis/redis-rb
+  # @option options [String] :namespace namespace of keys to be used to Redis
   def initialize(options = {})
     namespace = options.delete(:namespace)
     redis = Redis.new(options)
@@ -20,8 +19,8 @@ class Inferx
 
   # Get a score of a category according to a set of words.
   #
-  # @param [Inferx::Category] a category for scoring
-  # @param [Array<String>] a set of words
+  # @param [Inferx::Category] category a category for scoring
+  # @param [Array<String>] words a set of words
   # @return [Float] a score of the category
   def score(category, words)
     size = category.size.to_f
@@ -33,7 +32,7 @@ class Inferx
 
   # Get a score for each category according to a set of words.
   #
-  # @param [Array<String>] a set of words
+  # @param [Array<String>] words a set of words
   # @return [Hash<Symbol, Float>] scores to key a category
   #
   # @see #score
@@ -42,9 +41,9 @@ class Inferx
     Hash[@categories.map { |category| [category.name, score(category, words)] }]
   end
 
-  # Classify words to any one category
+  # Classify words to any one category.
   #
-  # @param [Array<String>] a set of words
+  # @param [Array<String>] words a set of words
   # @return [Symbol] most high-scoring category name
   #
   # @see #score

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: inferx
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-02 00:00:00.000000000 Z
+date: 2012-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -97,3 +97,4 @@ test_files:
 - spec/inferx/category_spec.rb
 - spec/inferx_spec.rb
 - spec/spec_helper.rb
+has_rdoc: