hnswlib 0.6.2 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc8a40172623a3439b17c8b1854017c845bf4dc23f4e1714e9427e4b6b701c9b
-  data.tar.gz: 95fa48d791f000bf48809e7067efaba9a654ab0dd517c626f689c66af3668d0e
+  metadata.gz: b5b9bb4199b5f8632fe95367083d304c47588d32c7a278cf962fff2a21a1bcda
+  data.tar.gz: be1988b82ab3dee3fcb0926746b20db29f9dfe7c50598c0bd096245454cf6d4f
 SHA512:
-  metadata.gz: 07c449031cc7afbf80803ae15c8094589a146b59b1852ea72e88fcd39067def572bbdd58277e3a85c47c537e8dc6eef645f9f404a2b874e4e217b559adc38054
-  data.tar.gz: 4b71a7f4fe0ffb3c15124e32c9c8fbba9eb6f82e6f0b95f5d91dd35c6b10be8aeba25d7313eabeaa5078b051b3410195415843ecd600b58ec1b0b36532b7ae1d
+  metadata.gz: 7633712aadef67f78daa1e1d6d8534cf4f3d9e9f301b204df59b4f14f46bc8ffc33952a54d0e5ea5a66b5976bd0d27b532c9c922115baf974816fe7986de5739
+  data.tar.gz: c2fde5d220d72920cfe23c7cfe8f9bdd01d6719ea6f3dba0eff07f76c6bf02cb498c9ea68ddae8c4236d94ea46ac0b2468bcf284be376a804580065754121937

data/CHANGELOG.md

@@ -1,3 +1,31 @@
+## [0.8.0] - 2023-03-14
+
+**Breaking change:**
+
+- Change to give a String to the space argument of the `initialize` method
+in [HierarchicalNSW](https://yoshoku.github.io/hnswlib.rb/doc/Hnswlib/HierarchicalNSW.html) and [BruteforceSearch](https://yoshoku.github.io/hnswlib.rb/doc/Hnswlib/BruteforceSearch.html).
+- Add `init_index` method to HierarchicalNSW and BruteforceSearch.
+Along with this, some arguments of `initialize` method moved to `init_index` method.
+  ```ruby
+  require 'hnswlib'
+
+  n_features = 3
+  max_elements = 10
+
+  hnsw = Hnswlib::HierarchicalNSW.new(space: 'l2', dim: n_features)
+  hnsw.init_index(max_elements: max_elements, m: 16, ef_construction: 200, random_seed: 42, allow_replace_deleted: false)
+
+  bf = Hnswlib::BruteforceSearch.new(space: 'l2', dim: n_features)
+  bf.init_index(max_elements: max_elements)
+  ```
+- Deprecate [HnswIndex](https://yoshoku.github.io/hnswlib.rb/doc/Hnswlib/HnswIndex.html) has interface similar to Annoy.
+
+## [0.7.0] - 2023-03-04
+
+- Update bundled hnswlib version to 0.7.0.
+- Add support for replacing an element marked for deletion with a new element.
+- Add support filtering function by label in search_knn method of BruteforeceSearch and HierarchicalNSW.
+
 ## [0.6.2] - 2022-06-25
 
 - Refactor codes and configs with RuboCop and clang-format.

data/README.md

@@ -48,19 +48,26 @@ $ gem install hnswlib -- --with-cxxflags=-march=native
 ```ruby
 require 'hnswlib'
 
-f = 40 # length of item vector that will be indexed.
-t = Hnswlib::HnswIndex.new(n_features: f, max_item: 1000)
+f = 40 # length of datum point vector that will be indexed.
+t = Hnswlib::HierarchicalNSW.new(space: 'l2', dim: f)
+t.init_index(max_elements: 1000)
 
 1000.times do |i|
   v = Array.new(f) { rand }
-  t.add_item(i, v)
+  t.add_point(v, i)
 end
 
-t.save('test.ann')
+t.save_index('test.ann')
+```
+
+```ruby
+require 'hnswlib'
+
+u = Hnswlib::HierarchicalNSW.new(space: 'l2', dim: f)
+u.load_index('test.ann')
 
-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.
+q = Array.new(f) { rand }
+p u.search_knn(q, 100) # will find the 100 nearest neighbors.
 ```
 
 ## License

data/ext/hnswlib/hnswlibext.cpp

@@ -1,7 +1,7 @@
 /**
  * hnswlib.rb is a Ruby binding for the Hnswlib.
  *
- * Copyright (c) 2021-2022 Atsushi Tatsuma
+ * Copyright (c) 2021-2023 Atsushi Tatsuma
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -18,8 +18,6 @@
 
 #include "hnswlibext.hpp"
 
-VALUE rb_mHnswlib;
-
 extern "C" void Init_hnswlibext(void) {
   rb_mHnswlib = rb_define_module("Hnswlib");
   RbHnswlibL2Space::define_class(rb_mHnswlib);