deepstack 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be874725c205c1b4c704649e99506f362fc711eeff315d9616deb112f7caecd5
-  data.tar.gz: f3a54bde1b2d8a533e9af9c58154a9004c7133f3e383d8e612a91d6052187fe1
+  metadata.gz: '02929889eabbeeb8b76cd2f588cef7452ef0bb6dd3687fad749105e6956191e9'
+  data.tar.gz: 2625f0bc5aac522d23461530dda2e581718c4f967c053db13c13ff0dcaa46f92
 SHA512:
-  metadata.gz: 9c7d7c9f0abe1465489936961e9cc297c1e9961b2e6afe6b2612fea975b5b0cc0c24a95748fd6fe14e5b45e480d15a27237ad5e5b01d4f84a8617258a659fcc1
-  data.tar.gz: d4d9f966dd440a3cd3031c3ba64b029d0f94b427945d64b77cd23aea3f1a900de2fea85a2f24ddd49fca8c1c821c7e3c6b7c63a9e120fc38e481ed1452ec388b
+  metadata.gz: fd37e76b9ad0fd30ddcc8a995fe2267d01f056cb3aa3a1d134b6335d91b6b300f61ce9929ab6b2e183ead1036135d2854a53858306395caadfaca7f2baf083d2
+  data.tar.gz: 275bba97d88a57d51de45a0ae2be230df5d2a8c749324ea748cd2a16c9e45de9c8f6c44d0d61fd860985400093e1caec636f1905bfbcab680631b39087bfbffa

data/lib/deep_stack/custom_model.rb

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
 
 class DeepStack
-  # Custom Model
+  # Support for using Custom Models with DeepStack
   module CustomModel
     #
-    # Return predictions using a custom model
+    # Return predictions using a custom model.
+    # Custom models are *.pt models that have been saved in DeepStack's modelstore directory.
+    # See https://docs.deepstack.cc/custom-models/deployment/index.html
     #
     # @param [String] model custom model name
     # @param [Object] image binary data or a File object

data/lib/deep_stack/face.rb

@@ -77,5 +77,24 @@ class DeepStack
       target = 'vision/face/register'
       api_post(target, images, userid: userid)&.dig('success') == true
     end
+
+    #
+    # Call DeepStack's Face Match service. Compare two different pictures and tells the similarity between them.
+    #
+    # @example
+    #   image1 = File.read('obama1.jpg')
+    #   image2 = File.read('obama2.jpg')
+    #   puts deepstack.face_match(image1, image2) > 0.6 ? 'similar' : 'different'
+    #
+    # @param [Array] *images two images to compare
+    # @param [kwargs] **args optional arguments to the API call
+    #
+    # @return [Float] The similarity score (0-1)
+    # @return [nil] if failed
+    #
+    def face_match(*images, **args)
+      target = 'vision/face/match'
+      api_post(target, images, **args)&.dig('similarity')
+    end
   end
 end

data/lib/deep_stack/version.rb

@@ -5,5 +5,5 @@
 #
 class DeepStack
   # @return [String] Version of DeepStack helper libraries
-  VERSION = '1.3.0'
+  VERSION = '1.4.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: deepstack
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Jimmy Tanagra