cosine-similarity 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e7968a15556f769f7cb90338cebaf24c359ac2cb221f5e6c1381d1e31421d85e
+  data.tar.gz: 855618955acffcfd7c419b746cf9c53fb0f9be1adfc7bbd2b0c9814f6356057f
+SHA512:
+  metadata.gz: 0dbcbf28d6d8d57f4efa65f7c53e8ac1d08f9f431d3ce5fd2fc1e2d0844a91a1939ae991ab43b54d0fed8681dbfc600be0123819d9c18393281d3695725fadca
+  data.tar.gz: fdbd3dec631e3c695324581cd99936d43f3913b3c2143490678fa517cdb8c8b070f46b236c24bf8951f41c36d3d38d385919120122697f47b36a95e731b34dcf

data/lib/cosine_similarity.rb

@@ -0,0 +1,10 @@
+def cosine_similarity(embedding1, embedding2)
+  if !embedding1.is_a?(Array) || !embedding2.is_a?(Array)
+    return 'Error: Both arguments must be arrays'
+  else
+    dot_product = embedding1.zip(embedding2).map{|x,y| x*y}.sum
+    norm1 = Math.sqrt(embedding1.map{|x| x**2}.sum)
+    norm2 = Math.sqrt(embedding2.map{|x| x**2}.sum)
+    return dot_product / (norm1 * norm2)
+  end
+end

data/spec/cosine_similarity_spec.rb

@@ -0,0 +1,25 @@
+require './cosine_similarity.rb'
+
+describe '#cosine_similarity' do
+  context 'when both arguments are arrays' do
+    it 'returns the cosine similarity of the two identical embeddings' do
+      embedding1 = [1, 2, 3]
+      embedding2 = [1, 2, 3]
+      expect(cosine_similarity(embedding1, embedding2)).to eq(1)
+    end
+
+    it 'returns the cosine similarity of the two identical embeddings' do
+      embedding1 = [1, 2, 3]
+      embedding2 = [1, 2, 4]
+      expect(cosine_similarity(embedding1, embedding2)).to eq(0.9914601339836675)
+    end
+  end
+
+  context 'when either argument is not an array' do
+    it 'returns an error message' do
+      embedding1 = [1, 2, 3]
+      embedding2 = 'not an array'
+      expect(cosine_similarity(embedding1, embedding2)).to eq('Error: Both arguments must be arrays')
+    end
+  end
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: cosine-similarity
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Kane Hooper
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-02-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+description: This gem provides a method for calculating the cosine similarity between
+  two vector embeddings.
+email:
+- kanehooper@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/cosine_similarity.rb
+- spec/cosine_similarity_spec.rb
+homepage: https://rubygems.org/gems/cosine-similarity
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/reinteractive/cosine-similarity
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: A gem for calculating cosine similarity between two vectors.
+test_files: []