ngt 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bff3db4fe839a13d6c1d0c5c959c4e42bf738670c69b0fd4792a1209c7e7165f
-  data.tar.gz: ed3c9d563903be2c8d550bccbeb7efd40cb78b1f5d78e8d6846e9dc4063f78f6
+  metadata.gz: d00cfd25aa3d93228994f1f490c27e5c7bd0566013c6d4af9c9ec22157cd5bf0
+  data.tar.gz: a33f524d222fc6b9c7733039217349e9897926b19854faff58f088a80bb55b58
 SHA512:
-  metadata.gz: 7e85cd285bac398611fcae5d3bae99f9b13422b1dab068387f787d91b9137eb7ffdf6b96e1d64a5719ce6eef8fef8c2a2e7f8553893ee535f8f9f09ca55ca9b3
-  data.tar.gz: 9645e1859e2c65d88688b23006a94bb272b8ad19c6df64a43427c8842d1e49b26fe3431524c02c74eefacfa0c20360760fb6c31691583190d1d323efb688a7ed
+  metadata.gz: 1e1431ab3453ce24ab8d3886fc4ce201cc48ec239eb8eb083bb72d9880d8bf554e2e45ce7252e207d7e7da7f10323023364ff1b33ca95ab6bd6795fdbf79e5c0
+  data.tar.gz: 3a932a1da2b75baac08ac477f9e92d1d6f203237f3b94e6962c749d906eb7c63a4a5f0162395f39db21734338ba147a10acb4210cb37d5397d024aef00f32795

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.2.4 (2020-03-09)
+
+- Updated NGT to 1.9.1
+- Added support for passing an index to optimizers
+- Added `dimensions`, `distance_type`, `edge_size_for_creation`, `edge_size_for_search`, and `object_type` methods
+
 ## 0.2.3 (2020-03-08)
 
 - Added `load` method

data/README.md

@@ -12,7 +12,7 @@ Add this line to your application’s Gemfile:
 gem 'ngt'
 ```
 
-NGT is not available for Windows yet
+NGT is not available for Windows
 
 ## Getting Started
 
@@ -84,7 +84,8 @@ Optimize the index
 
 ```ruby
 optimizer = Ngt::Optimizer.new(outgoing: 10, incoming: 120)
-optimizer.execute(path, new_path)
+optimizer.adjust_search_coefficients(index)
+optimizer.execute(index, new_path)
 ```
 
 ## Full Example
@@ -108,6 +109,38 @@ result.each do |res|
 end
 ```
 
+## Index Options
+
+Defaults shown below
+
+```ruby
+Ngt::Index.new(dimensions,
+  edge_size_for_creation: 10,
+  edge_size_for_search: 40,
+  object_type: :float, # :float, :integer
+  distance_type: :l2,  # :l1, :l2, :hamming, :angle, :cosine, or :jaccard
+  path: nil
+)
+```
+
+## Optimizer Options
+
+Defaults shown below
+
+```ruby
+Ngt::Optimizer.new(
+  outgoing: 10,
+  incoming: 120,
+  queries: 100,
+  low_accuracy_from: 0.3,
+  low_accuracy_to: 0.5,
+  high_accuracy_from: 0.8,
+  high_accuracy_to: 0.9,
+  gt_epsilon: 0.1,
+  merge: 0.2
+)
+```
+
 ## Data
 
 Data can be an array of arrays

data/lib/ngt/ffi.rb

@@ -2,11 +2,7 @@ module Ngt
   module FFI
     extend ::FFI::Library
 
-    begin
-      ffi_lib Ngt.ffi_lib
-    rescue LoadError => e
-      raise e
-    end
+    ffi_lib Ngt.ffi_lib
 
     # https://github.com/yahoojapan/NGT/blob/master/lib/NGT/Capi.h
     # keep same order
@@ -52,6 +48,9 @@ module Ngt
     attach_function :ngt_get_object_as_integer, %i[pointer int pointer], :pointer
     attach_function :ngt_destroy_property, %i[pointer], :void
     attach_function :ngt_close_index, %i[pointer], :void
+    attach_function :ngt_get_property_edge_size_for_creation, %i[pointer pointer], :int16
+    attach_function :ngt_get_property_edge_size_for_search, %i[pointer pointer], :int16
+    attach_function :ngt_get_property_distance_type, %i[pointer pointer], :int32
     attach_function :ngt_create_error_object, %i[], :pointer
     attach_function :ngt_get_error_string, %i[pointer], :string
     attach_function :ngt_destroy_error_object, %i[pointer], :void

data/lib/ngt/index.rb

@@ -2,6 +2,10 @@ module Ngt
   class Index
     include Utils
 
+    DISTANCE_TYPES = [:l1, :l2, :hamming, :angle, :cosine, :normalized_angle, :normalized_cosine, :jaccard]
+
+    attr_reader :dimensions, :distance_type, :edge_size_for_creation, :edge_size_for_search, :object_type, :path
+
     def initialize(path)
       @path = path
       @error = FFI.ngt_create_error_object
@@ -10,10 +14,14 @@ module Ngt
       property = ffi(:ngt_create_property)
       ffi(:ngt_get_property, @index, property)
 
-      @dimension = ffi(:ngt_get_property_dimension, property)
+      @dimensions = ffi(:ngt_get_property_dimension, property)
+      @distance_type = DISTANCE_TYPES[ffi(:ngt_get_property_distance_type, property)]
+      @edge_size_for_creation = ffi(:ngt_get_property_edge_size_for_creation, property)
+      @edge_size_for_search = ffi(:ngt_get_property_edge_size_for_search, property)
 
       object_type = ffi(:ngt_get_property_object_type, property)
       @float = FFI.ngt_is_property_object_type_float(object_type)
+      @object_type = @float ? :float : :integer
 
       @object_space = ffi(:ngt_get_object_space, @index)
 
@@ -21,7 +29,7 @@ module Ngt
     end
 
     def insert(object)
-      ffi(:ngt_insert_index, @index, c_object(object.to_a), @dimension)
+      ffi(:ngt_insert_index, @index, c_object(object.to_a), @dimensions)
     end
 
     def batch_insert(objects, num_threads: 8)
@@ -53,10 +61,10 @@ module Ngt
     def object(id)
       if float?
         res = ffi(:ngt_get_object_as_float, @object_space, id)
-        res.read_array_of_float(@dimension)
+        res.read_array_of_float(@dimensions)
       else
         res = ffi(:ngt_get_object_as_integer, @object_space, id)
-        res.read_array_of_uint8(@dimension)
+        res.read_array_of_uint8(@dimensions)
       end
     end
 
@@ -67,7 +75,7 @@ module Ngt
     def search(query, size: 20, epsilon: 0.1, radius: nil)
       radius ||= -1.0
       results = ffi(:ngt_create_empty_results)
-      ffi(:ngt_search_index, @index, c_object(query.to_a), @dimension, size, epsilon, radius, results)
+      ffi(:ngt_search_index, @index, c_object(query.to_a), @dimensions, size, epsilon, radius, results)
       result_size = ffi(:ngt_get_result_size, results)
       ret = []
       result_size.times do |i|
@@ -90,47 +98,47 @@ module Ngt
       FFI.ngt_close_index(@index)
     end
 
-    def self.new(dimension, path: nil, edge_size_for_creation: 10,
-        edge_size_for_search: 40, object_type: "Float", distance_type: "L2")
+    def self.new(dimensions, path: nil, edge_size_for_creation: 10,
+        edge_size_for_search: 40, object_type: :float, distance_type: :l2)
 
       # called from load
-      return super(path) if path && dimension.nil?
+      return super(path) if path && dimensions.nil?
 
       # TODO remove in 0.3.0
-      create = dimension.is_a?(Integer) || path
+      create = dimensions.is_a?(Integer) || path
       unless create
         warn "[ngt] Passing a path to new is deprecated - use load instead"
-        return super(dimension)
+        return super(dimensions)
       end
 
       path ||= Dir.mktmpdir
       error = FFI.ngt_create_error_object
       property = ffi(:ngt_create_property, error)
-      ffi(:ngt_set_property_dimension, property, dimension, error)
+      ffi(:ngt_set_property_dimension, property, dimensions, error)
       ffi(:ngt_set_property_edge_size_for_creation, property, edge_size_for_creation, error)
       ffi(:ngt_set_property_edge_size_for_search, property, edge_size_for_search, error)
 
-      case object_type.to_s
-      when "Float", "float"
+      case object_type.to_s.downcase
+      when "float"
         ffi(:ngt_set_property_object_type_float, property, error)
-      when "Integer", "integer"
+      when "integer"
         ffi(:ngt_set_property_object_type_integer, property, error)
       else
         raise ArgumentError, "Unknown object type: #{object_type}"
       end
 
-      case distance_type.to_s
-      when "L1"
+      case distance_type.to_s.downcase
+      when "l1"
         ffi(:ngt_set_property_distance_type_l1, property, error)
-      when "L2"
+      when "l2"
         ffi(:ngt_set_property_distance_type_l2, property, error)
-      when "Angle"
+      when "angle"
         ffi(:ngt_set_property_distance_type_angle, property, error)
-      when "Hamming"
+      when "hamming"
         ffi(:ngt_set_property_distance_type_hamming, property, error)
-      when "Jaccard"
+      when "jaccard"
         ffi(:ngt_set_property_distance_type_jaccard, property, error)
-      when "Cosine"
+      when "cosine"
         ffi(:ngt_set_property_distance_type_cosine, property, error)
       else
         raise ArgumentError, "Unknown distance type: #{distance_type}"
@@ -151,9 +159,9 @@ module Ngt
       new(nil, path: path)
     end
 
-    def self.create(path, dimension, **options)
+    def self.create(path, dimensions, **options)
       warn "[ngt] create is deprecated - use new instead"
-      new(dimension, path: path, **options)
+      new(dimensions, path: path, **options)
     end
 
     # private

data/lib/ngt/optimizer.rb

@@ -15,11 +15,11 @@ module Ngt
     end
 
     def execute(in_index_path, out_index_path)
-      ffi(:ngt_optimizer_execute, @optimizer, in_index_path, out_index_path)
+      ffi(:ngt_optimizer_execute, @optimizer, path(in_index_path), out_index_path)
     end
 
     def adjust_search_coefficients(index_path)
-      ffi(:ngt_optimizer_adjust_search_coefficients, @optimizer, index_path)
+      ffi(:ngt_optimizer_adjust_search_coefficients, @optimizer, path(index_path))
     end
 
     def self.finalize(optimizer, error)
@@ -29,5 +29,11 @@ module Ngt
         FFI.ngt_destroy_error_object(error)
       end
     end
+
+    private
+
+    def path(obj)
+      obj.is_a?(Ngt::Index) ? obj.path : obj
+    end
   end
 end

data/lib/ngt/version.rb

@@ -1,3 +1,3 @@
 module Ngt
-  VERSION = "0.2.3"
+  VERSION = "0.2.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ngt
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Andrew Kane