neighbor 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8aa6de2790d94de9411b0142836b2ad181a411e299fce4b98357b96ac4161183
-  data.tar.gz: 2924d7f15f5b36bc89ee72372c1bfeb373d99481269696a9a9dcc41f90201f38
+  metadata.gz: dfc4af6302c7098ea40f96e9d8a19706aff46a2506cad541ff18ee07fcd11019
+  data.tar.gz: a79b59895ca3b99a7c048eddd20cb3602b2660425ab44463e7021ab763a26f62
 SHA512:
-  metadata.gz: 2bc1b3ee6d5b1ee0ab175b017e753cf958bd8ceb1ef2a23ba769770dfebf54eec251ac59c8f5f3b6ca56efcbad1763c34622b94924a017622c2f78fc8740f762
-  data.tar.gz: d946dda99833964582f63863b2d898fea6bf065312cf60aec873631df96195e1a54375606ad9c9cc0f767937cdb7ea38b0d9990efcbbeab15ccbb11f8a2020ef
+  metadata.gz: 11081e687de4c79428351095477137f9140bc6c0363d09c54ece8fd5f7bbe2df802d740332f4474357f9e9e57157bd1f1f4dd3671c106d24dc7e01e2f0d84e2a
+  data.tar.gz: f18d787b22df7bbc00c69b1f9f6262e19c0214f6ef28814a5c05d9e8c3dae357f32596994bef60112d3f53dac0c1b51f6c99af6345c7e01b2f26cef1a7b42226

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.4.2 (2024-08-27)
+
+- Fixed error with `nil` values
+
 ## 0.4.1 (2024-08-26)
 
 - Added `precision` option

data/README.md

@@ -14,7 +14,7 @@ gem "neighbor"
 
 ## Choose An Extension
 
-Neighbor supports two extensions: [cube](https://www.postgresql.org/docs/current/cube.html) and [vector](https://github.com/pgvector/pgvector). cube ships with Postgres, while vector supports more dimensions and approximate nearest neighbor search.
+Neighbor supports two extensions: [cube](https://www.postgresql.org/docs/current/cube.html) and [pgvector](https://github.com/pgvector/pgvector). cube ships with Postgres, while pgvector supports more dimensions and approximate nearest neighbor search.
 
 For cube, run:
 
@@ -23,7 +23,7 @@ rails generate neighbor:cube
 rails db:migrate
 ```
 
-For vector, [install pgvector](https://github.com/pgvector/pgvector#installation) and run:
+For pgvector, [install the extension](https://github.com/pgvector/pgvector#installation) and run:
 
 ```sh
 rails generate neighbor:vector
@@ -70,17 +70,30 @@ Get the nearest neighbors to a vector
 Item.nearest_neighbors(:embedding, [0.9, 1.3, 1.1], distance: "euclidean").first(5)
 ```
 
-## Distance
+Records returned from `nearest_neighbors` will have a `neighbor_distance` attribute
+
+```ruby
+nearest_item = item.nearest_neighbors(:embedding, distance: "euclidean").first
+nearest_item.neighbor_distance
+```
+
+See the additional docs for:
+
+- [cube](#cube)
+- [pgvector](#pgvector)
+
+Or check out some [examples](#examples)
+
+## cube
+
+### Distance
 
 Supported values are:
 
 - `euclidean`
 - `cosine`
 - `taxicab`
-- `chebyshev` (cube only)
-- `inner_product` (vector only)
-- `hamming` (vector only)
-- `jaccard` (vector only)
+- `chebyshev`
 
 For cosine distance with cube, vectors must be normalized before being stored.
 
@@ -90,18 +103,11 @@ class Item < ApplicationRecord
 end
 ```
 
-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
-
-```ruby
-nearest_item = item.nearest_neighbors(:embedding, distance: "euclidean").first
-nearest_item.neighbor_distance
-```
+For inner product with cube, see [this example](examples/disco/user_recs_cube.rb).
 
-## Dimensions
+### Dimensions
 
-The cube data type can have up to 100 dimensions by default. See the [Postgres docs](https://www.postgresql.org/docs/current/cube.html) for how to increase this. The vector data type can have up to 16,000 dimensions, and vectors with up to 2,000 dimensions can be indexed.
+The `cube` type can have up to 100 dimensions by default. See the [Postgres docs](https://www.postgresql.org/docs/current/cube.html) for how to increase this.
 
 For cube, it’s a good idea to specify the number of dimensions to ensure all records have the same number.
 
@@ -111,9 +117,26 @@ class Item < ApplicationRecord
 end
 ```
 
-## Indexing
+## pgvector
+
+### Distance
+
+Supported values are:
+
+- `euclidean`
+- `inner_product`
+- `cosine`
+- `taxicab`
+- `hamming`
+- `jaccard`
+
+### Dimensions
+
+The `vector` type can have up to 16,000 dimensions, and vectors with up to 2,000 dimensions can be indexed.
+
+### Indexing
 
-For vector, add an approximate index to speed up queries. Create a migration with:
+Add an approximate index to speed up queries. Create a migration with:
 
 ```ruby
 class AddIndexToItemsEmbedding < ActiveRecord::Migration[7.2]
@@ -139,7 +162,7 @@ Or the number of probes with IVFFlat
 Item.connection.execute("SET ivfflat.probes = 3")
 ```
 
-## Half-Precision Vectors
+### Half-Precision Vectors
 
 Use the `halfvec` type to store half-precision vectors
 
@@ -151,7 +174,7 @@ class AddEmbeddingToItems < ActiveRecord::Migration[7.2]
 end
 ```
 
-## Half-Precision Indexing
+### Half-Precision Indexing
 
 Index vectors at half precision for smaller indexes
 
@@ -169,7 +192,7 @@ Get the nearest neighbors
 Item.nearest_neighbors(:embedding, [0.9, 1.3, 1.1], distance: "euclidean", precision: "half").first(5)
 ```
 
-## Binary Vectors
+### Binary Vectors
 
 Use the `bit` type to store binary vectors
 
@@ -187,7 +210,7 @@ Get the nearest neighbors by Hamming distance
 Item.nearest_neighbors(:embedding, "101", distance: "hamming").first(5)
 ```
 
-## Binary Quantization
+### Binary Quantization
 
 Use expression indexing for binary quantization
 
@@ -199,7 +222,7 @@ class AddIndexToItemsEmbedding < ActiveRecord::Migration[7.2]
 end
 ```
 
-## Sparse Vectors
+### Sparse Vectors
 
 Use the `sparsevec` type to store sparse vectors
 
@@ -543,7 +566,7 @@ movie = Movie.find_by(name: "Star Wars (1977)")
 movie.nearest_neighbors(:factors, distance: "cosine").first(5).map(&:name)
 ```
 
-See the complete code for [cube](examples/disco/item_recs_cube.rb) and [vector](examples/disco/item_recs_vector.rb)
+See the complete code for [cube](examples/disco/item_recs_cube.rb) and [pgvector](examples/disco/item_recs_vector.rb)
 
 ## History
 

data/lib/neighbor/type/cube.rb

@@ -6,7 +6,7 @@ module Neighbor
       end
 
       def serialize(value)
-        if value.respond_to?(:to_a)
+        if Utils.array?(value)
           value = value.to_a
           if value.first.is_a?(Array)
             value = value.map { |v| serialize_point(v) }.join(", ")
@@ -20,7 +20,7 @@ module Neighbor
       private
 
       def cast_value(value)
-        if value.respond_to?(:to_a)
+        if Utils.array?(value)
           value.to_a
         elsif value.is_a?(Numeric)
           [value]

data/lib/neighbor/type/halfvec.rb

@@ -6,7 +6,7 @@ module Neighbor
       end
 
       def serialize(value)
-        if value.respond_to?(:to_a)
+        if Utils.array?(value)
           value = "[#{value.to_a.map(&:to_f).join(",")}]"
         end
         super(value)
@@ -17,7 +17,7 @@ module Neighbor
       def cast_value(value)
         if value.is_a?(String)
           value[1..-1].split(",").map(&:to_f)
-        elsif value.respond_to?(:to_a)
+        elsif Utils.array?(value)
           value.to_a
         else
           raise "can't cast #{value.class.name} to halfvec"

data/lib/neighbor/type/sparsevec.rb

@@ -19,7 +19,7 @@ module Neighbor
           value
         elsif value.is_a?(String)
           SparseVector.from_text(value)
-        elsif value.respond_to?(:to_a)
+        elsif Utils.array?(value)
           value = SparseVector.new(value.to_a)
         else
           raise "can't cast #{value.class.name} to sparsevec"

data/lib/neighbor/type/vector.rb

@@ -6,7 +6,7 @@ module Neighbor
       end
 
       def serialize(value)
-        if value.respond_to?(:to_a)
+        if Utils.array?(value)
           value = "[#{value.to_a.map(&:to_f).join(",")}]"
         end
         super(value)
@@ -17,7 +17,7 @@ module Neighbor
       def cast_value(value)
         if value.is_a?(String)
           value[1..-1].split(",").map(&:to_f)
-        elsif value.respond_to?(:to_a)
+        elsif Utils.array?(value)
           value.to_a
         else
           raise "can't cast #{value.class.name} to vector"

data/lib/neighbor/utils.rb

@@ -38,5 +38,9 @@ module Neighbor
       # could also throw error
       norm > 0 ? value.map { |v| v / norm } : value
     end
+
+    def self.array?(value)
+      !value.nil? && value.respond_to?(:to_a)
+    end
   end
 end

data/lib/neighbor/version.rb

@@ -1,3 +1,3 @@
 module Neighbor
-  VERSION = "0.4.1"
+  VERSION = "0.4.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: neighbor
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Andrew Kane