neighbor 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a8839eeaeeef5b3ff8deb63165791929a81f9a9c1c807dd3d094e9bf770e881
-  data.tar.gz: 14035d37686f7035bc0e874de7933259dc0b8be9d046fca1d31867cacaf1c922
+  metadata.gz: 8a71d9aff5133b9551dc47cfe490d5d6a0ee63d2b77ac1d3d2f381f58aef67d6
+  data.tar.gz: d22cab3140b979ee0d13ddd2c99f064282e896d49c265bf9b1946dafbda7783a
 SHA512:
-  metadata.gz: bfbf7bca1b4290abf2ec91dd5ea032dd1878ab9d7a0938dfed4e6e63441aa557397345090713222a735beb32bc9f1b6cd7971536de9ca427db8650f053917040
-  data.tar.gz: 1ba36cba82aafbb2bb003e016f0817884b1129a7d0a8b2be7385e438999e6e7728224f7e146d4de611e171fc851ae64ebea3aa7bfa65f55868cb0c5477d8ecff
+  metadata.gz: 3e24a71c6ace693525fc4866aaa21ee7c75f7251d5d6e0820da3b6abc0bd6fd5921b20c2edbb7fc656b75991e1fc5607357dc02870072900e7b6ef972c840280
+  data.tar.gz: 5b75200355c62c549c2d61820e74e1cc71e4ebce68a1e390af60dbe76b6e1b7a69e71d73c8121db42ea05fc296db4ecc1f5776c71ad988685f13f71fc00fec66

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.2.1 (2021-12-15)
+
+- Added support for Active Record 7
+
 ## 0.2.0 (2021-04-21)
 
 - Added support for pgvector

data/README.md

@@ -23,7 +23,7 @@ rails generate neighbor:cube
 rails db:migrate
 ```
 
-For vector, install [pgvector](https://github.com/ankane/pgvector#installation) and run:
+For vector, [install pgvector](https://github.com/ankane/pgvector#installation) and run:
 
 ```sh
 rails generate neighbor:vector
@@ -39,7 +39,7 @@ class AddNeighborVectorToItems < ActiveRecord::Migration[6.1]
   def change
     add_column :items, :neighbor_vector, :cube
     # or
-    add_column :items, :neighbor_vector, :vector, limit: 3
+    add_column :items, :neighbor_vector, :vector, limit: 3 # dimensions
   end
 end
 ```
@@ -88,7 +88,7 @@ class Item < ApplicationRecord
 end
 ```
 
-For inner product with cube, see [this example](examples/disco_user_recs.rb).
+For inner product with cube, see [this example](examples/disco_user_recs_cube.rb).
 
 Records returned from `nearest_neighbors` will have a `neighbor_distance` attribute
 
@@ -116,12 +116,12 @@ For vector, add an approximate index to speed up queries. Create a migration wit
 ```ruby
 class AddIndexToItemsNeighborVector < ActiveRecord::Migration[6.1]
   def change
-    add_index :items, :neighbor_vector, using: :ivfflat
+    add_index :items, :neighbor_vector, using: :ivfflat, opclass: :vector_l2_ops
   end
 end
 ```
 
-Add `opclass: :vector_cosine_ops` for cosine distance and `opclass: :vector_ip_ops` for inner product.
+Use `:vector_cosine_ops` for cosine distance and `:vector_ip_ops` for inner product.
 
 Set the number of probes
 
@@ -159,9 +159,11 @@ recommender.fit(data)
 Use item factors for the neighbor vector
 
 ```ruby
+movies = []
 recommender.item_ids.each do |item_id|
-  Movie.create!(name: item_id, neighbor_vector: recommender.item_factors(item_id))
+  movies << {name: item_id, neighbor_vector: recommender.item_factors(item_id)}
 end
+Movie.insert_all!(movies) # use create! for Active Record < 6
 ```
 
 And get similar movies
@@ -171,7 +173,7 @@ movie = Movie.find_by(name: "Star Wars (1977)")
 movie.nearest_neighbors(distance: "cosine").first(5).map(&:name)
 ```
 
-[Complete code](examples/disco_item_recs.rb)
+See the complete code for [cube](examples/disco_item_recs_cube.rb) and [vector](examples/disco_item_recs_vector.rb)
 
 ## Upgrading
 
@@ -204,5 +206,11 @@ To get started with development:
 git clone https://github.com/ankane/neighbor.git
 cd neighbor
 bundle install
+createdb neighbor_test
+
+# cube
 bundle exec rake test
+
+# vector
+EXT=vector bundle exec rake test
 ```

data/lib/neighbor/version.rb

@@ -1,3 +1,3 @@
 module Neighbor
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/lib/neighbor.rb

@@ -44,5 +44,9 @@ ActiveSupport.on_load(:active_record) do
   end
 
   # prevent unknown OID warning
-  ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.prepend(Neighbor::RegisterTypes)
+  if ActiveRecord::VERSION::MAJOR >= 7
+    ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.singleton_class.prepend(Neighbor::RegisterTypes)
+  else
+    ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.prepend(Neighbor::RegisterTypes)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: neighbor
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Andrew Kane
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-22 00:00:00.000000000 Z
+date: 2021-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -60,7 +60,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
 summary: Nearest neighbor search for Rails and Postgres