hnswlib 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 84f3ca262eddd8b331cbedc163e55e28d77eba76d2184332fef6afd0e2ddcce5
-  data.tar.gz: 248f8ca655ae83e2f56b26910dde6e96a23771040d61bac7ee7204e294063c2a
+  metadata.gz: 7823039ef0a73f79011cbbb4dd8bb90f56549d82c93cee311725a2e728ab8809
+  data.tar.gz: be1846136d1d87c63d3aa49c404f9148c8d04d8c0ba4af65d6297096b5683150
 SHA512:
-  metadata.gz: 56d528a7ce9af7f96b291e74fc6a4c8ff1d3da3d66e1dbeed0dc8e884f5f5822b04e35d0fb12f83155a97ac1505a9a1db7b245cdcb2b08ba96ae6657743ccfeb
-  data.tar.gz: 47ca9c4db92798e07576505bc0c6b2a4f3ffb8afdcfdd020226232d8fca31d4259571509ce08ccde8eeecd06bcfa7cc2a5512c29d2568fa9b5d0ec0736aaa2ea
+  metadata.gz: 5ddd709e8bd403b959c7ab8bc21b17b6e264da0976a2d85a4acd7edeb057b7771d53fac337d3a6dfdd2718dcd499efd2b0f8633170241dd01269cd34753be10a
+  data.tar.gz: 11fd6ee5ca94949665fa30a106e926283c9e190030b47b6b001b0fd755ff5512f8b913b02bb79f1b51cb851c50867d0dca1a861fb2f09b6805e4d0b74bb033b5

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## [0.3.0] - 2021-08-08
+
+- Rename `Hnswlib::Index` to `Hnswlib::HnswIndex` (for compatibility, `Hnswlib::Index` has been an alis for `Hnswlib::HnswIndex`).
+- Update API documentation.
+
 ## [0.2.0] - 2021-08-02
 
 - Add binding class for the BruteforceSearch.

data/README.md

@@ -35,7 +35,7 @@ Or install it yourself as:
 require 'hnswlib'
 
 f = 40 # length of item vector that will be indexed.
-t = Hnswlib::Index.new(n_features: f, max_item: 1000)
+t = Hnswlib::HnswIndex.new(n_features: f, max_item: 1000)
 
 1000.times do |i|
   v = Array.new(f) { rand }
@@ -44,7 +44,7 @@ end
 
 t.save('test.ann')
 
-u = Hnswlib::Index.new(n_features: f, max_item: 1000)
+u = Hnswlib::HnswIndex.new(n_features: f, max_item: 1000)
 u.load('test.ann')
 p u.get_nns_by_item(0, 100) # will find the 100 nearest neighbors.
 ```

data/lib/hnswlib.rb

@@ -4,12 +4,12 @@ require_relative 'hnswlib/version'
 require_relative 'hnswlib/hnswlibext'
 
 module Hnswlib
-  # Index is a class that provides functions for k-nearest eighbors search.
+  # HnswIndex is a class that provides functions for k-nearest eighbors search.
   #
   # @example
   #   require 'hnswlib'
   #
-  #   index = Hnswlib::Index.new(n_features: 100, max_item: 10000)
+  #   index = Hnswlib::HnswIndex.new(n_features: 100, max_item: 10000)
   #
   #   5000.times do |item_id|
   #     item_vec = Array.new(100) { rand - 0.5 }
@@ -18,7 +18,7 @@ module Hnswlib
   #
   #   index.get_nns_by_item(0, 100)
   #
-  class Index
+  class HnswIndex
     # Returns the metric of index.
     # @return [String]
     attr_reader :metric
@@ -150,4 +150,7 @@ module Hnswlib
       @index.max_elements
     end
   end
+
+  # Index is alias of HnswIndex
+  Index = ::Hnswlib::HnswIndex
 end

data/lib/hnswlib/version.rb

@@ -3,7 +3,7 @@
 # Hnswlib.rb provides Ruby bindings for the Hnswlib.
 module Hnswlib
   # The version of Hnswlib.rb you install.
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 
   # The version of Hnswlib included with gem.
   HSWLIB_VERSION = '0.5.2'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hnswlib
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - yoshoku
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-02 00:00:00.000000000 Z
+date: 2021-08-08 00:00:00.000000000 Z
 dependencies: []
 description: Hnswlib.rb provides Ruby bindings for the Hnswlib.
 email: