deepstack 1.1.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b13995c10316b274d2b292316076cf96c96f945ac7304835ca5dc25fd873eaeb
-  data.tar.gz: 585b76987b8d1db73e05e78b777bf6fcd716e38f40c7c1e9b9150a7c833d84ec
+  metadata.gz: '02929889eabbeeb8b76cd2f588cef7452ef0bb6dd3687fad749105e6956191e9'
+  data.tar.gz: 2625f0bc5aac522d23461530dda2e581718c4f967c053db13c13ff0dcaa46f92
 SHA512:
-  metadata.gz: 41f4207559f4976ebf42864186661a538f6d45978958ec22a951c2e1ddac17685c67a2050de1064fe070c10f39fd9d3b954807be40bd04b14be5cf4e24221e5c
-  data.tar.gz: ceac07d54df401e92619d2c48e493ced1e6b2543a71bfe8dc79ccb5b1be53e34aa96d38eaf395b6bfbd919739c7476a886fac54fdb1fb9bf945a60cce6c0bba4
+  metadata.gz: fd37e76b9ad0fd30ddcc8a995fe2267d01f056cb3aa3a1d134b6335d91b6b300f61ce9929ab6b2e183ead1036135d2854a53858306395caadfaca7f2baf083d2
+  data.tar.gz: 275bba97d88a57d51de45a0ae2be230df5d2a8c749324ea748cd2a16c9e45de9c8f6c44d0d61fd860985400093e1caec636f1905bfbcab680631b39087bfbffa

data/lib/deep_stack/custom_model.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+class DeepStack
+  # Support for using Custom Models with DeepStack
+  module CustomModel
+    #
+    # 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
+    # @param [Hash] options additional fields for DeepStack, e.g. min_confidence: 0.5
+    #
+    # @return [Array] if successful, an array of DeepStack predictions
+    #
+    # @return [nil] if error
+    #
+    def custom_model(model, image, **options)
+      target = "vision/custom/#{model}"
+      api_post(target, image, **options)&.dig('predictions')
+    end
+    # @deprecated Use {custom_model} instead
+    alias custom_inference custom_model
+  end
+end

data/lib/deep_stack/deep_stack.rb

@@ -1,12 +1,11 @@
 # frozen_string_literal: true
 
-require 'pp'
 require 'net/http'
 require 'json'
 require_relative 'face'
 require_relative 'detection'
 require_relative 'scene'
-require_relative 'custom'
+require_relative 'custom_model'
 require_relative 'version'
 
 # DeepStack API
@@ -14,11 +13,21 @@ class DeepStack
   include DeepStack::Face
   include DeepStack::Detection
   include DeepStack::Scene
-  include DeepStack::Custom
+  include DeepStack::CustomModel
 
+  #
   # Create a deepstack object connected to the given URL
-  def initialize(base_url)
+  #
+  # @param [String] base_url the url to DeepStack's server:port
+  # @param [String] api_key an optional API-KEY to use when connecting to DeepStack
+  # @param [String] admin_key an optional ADMIN-KEY to use when connecting to DeepStack
+  #
+  # @example
+  #   DeepStack.new('http://127.0.0.1:5000')
+  #
+  def initialize(base_url, api_key: nil, admin_key: nil)
     @base_url = base_url
+    @auth = { api_key: api_key, admin_key: admin_key }.select { |_k, v| v } # remove nil values
     @http_mutex = Mutex.new
   end
 
@@ -33,6 +42,7 @@ class DeepStack
   #
   def api_post(path, *images, **args)
     uri = build_uri(path)
+    args = @auth.merge(args)
 
     result = nil
     10.times do
@@ -51,8 +61,7 @@ class DeepStack
   #
   def close
     @http_mutex.synchronize do
-      @http&.finish
-      @http = nil
+      @http.finish if @http&.started?
     end
   end
 
@@ -72,6 +81,7 @@ class DeepStack
     req.set_form(form_data, 'multipart/form-data')
     @http_mutex.synchronize do
       @http ||= Net::HTTP.start(uri.hostname, uri.port)
+      @http.start unless @http.started?
       @http.request(req)
     end
   end

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.1.1'
+  VERSION = '1.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deepstack
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.4.0
 platform: ruby
 authors:
 - Jimmy Tanagra
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-10 00:00:00.000000000 Z
+date: 2022-05-11 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
@@ -17,7 +17,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/deep_stack/custom.rb
+- lib/deep_stack/custom_model.rb
 - lib/deep_stack/deep_stack.rb
 - lib/deep_stack/detection.rb
 - lib/deep_stack/face.rb

data/lib/deep_stack/custom.rb

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-class DeepStack
-  # Custom Model
-  module Custom
-    #
-    # Register a custom inference method for convenience.
-    # The custom method is called "identify_<modelname>"
-    # Example:
-    #   deepstack.register_custom_model('license_plate')
-    #   deepstack.identify_license_plate(image)
-    #
-    # @param [Array] models a list of one or more custom model names to register
-    #
-    # @return [<Type>] <description>
-    #
-    def self.register_model(*models)
-      models.flatten.each do |model|
-        method_name = 'identify_'.concat model.gsub(/-+/, '_') # convert - to _
-        define_method(method_name) do |image, **options|
-          custom_inference(model, image, options)
-        end
-      end
-    end
-
-    #
-    # Return predictions using a custom model
-    #
-    # @param [String] model custom model name
-    # @param [Object] image binary data or a File object
-    # @param [Hash] options additional fields for DeepStack, e.g. min_confidence: 0.5
-    #
-    # @return [Array] if successful, an array of DeepStack predictions
-    #
-    # @return [nil] if error
-    #
-    def custom_inference(model, image, **options)
-      target = "vision/custom/#{model}"
-      api_post(target, image, options)&.dig('predictions')
-    end
-  end
-end