deepstack 1.2.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: caf4cf801a5a99ff308e5afc06ed19dac86d8348388c519880770d482fd1bb0b
-  data.tar.gz: de77bacb1bd1ffb46c4dff277ab16e1195ef423f005ad98394b49cab6e248fa3
+  metadata.gz: 6d3a74d72c68a1aef4f04d6b3a04d67cb26c89daf0bdfa1ba85a1cbfd904bd76
+  data.tar.gz: 2cc1bfddab42ebbc72ef9e1a90c35cc577e5a46e0db8d3900c42bc24dd15af64
 SHA512:
-  metadata.gz: 6836c3bc1e6dc367542c4bd9e3e089ddf2cf3a7e612d6230dfabf3f3a38a4651965eead00bba50dd5916e5a9d8fcc44c624f3743b17165fbda24cff8c9ea7ec8
-  data.tar.gz: 5f5c98987f6fae82a67ef8fa57a557aa300bd22da6108a8575eabe6e3ac8d1f301f57caad1f86b533629b503d53db4bb40e101ff630abddce1b2659637e2b177
+  metadata.gz: b12be0063b456923b065db6d9ae277aa30a32bc2a4e1c895a646b039d4770bd36dd296effc788cb7ace506be23dd64a836d11e77210184eb278b0b82ddda1818
+  data.tar.gz: ed627f25f85c15551b0758e9d87ea002f0cb95efdec5a6c31a92dd9a11936fc7bdddf51a570e61ebffc5995ce869c17d703df277421578428c187f7a724d64d5

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

@@ -5,7 +5,7 @@ require 'json'
 require_relative 'face'
 require_relative 'detection'
 require_relative 'scene'
-require_relative 'custom'
+require_relative 'custom_model'
 require_relative 'version'
 
 # DeepStack API
@@ -13,22 +13,34 @@ 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
   #
   # @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
+  # @param [String] api_key an optional API-KEY to use when connecting to DeepStack
+  # @param [Integer] verify_mode sets the flags for server the certification verification at
+  #                  beginning of SSL/TLS session.
+  #                  +OpenSSL::SSL::VERIFY_NONE+ or +OpenSSL::SSL::VERIFY_PEER+ are acceptable.
   #
   # @example
   #   DeepStack.new('http://127.0.0.1:5000')
   #
-  def initialize(base_url, api_key: nil, admin_key: nil)
+  #   # Using API KEY:
+  #   DeepStack.new('http://127.0.0.1:5000', api_key: 'secret', admin_key: 'supersecret')
+  #
+  #   # Connect to SSL with a self-signed certificate
+  #   DeepStack.new('https://localhost:443', verify_mode: OpenSSL::SSL::VERIFY_NONE)
+  #
+  def initialize(base_url, api_key: nil, admin_key: nil, verify_mode: 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
+    uri = URI(base_url)
+    http_options = {}
+    http_options[:verify_mode] = verify_mode if verify_mode
+    @http = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.instance_of?(URI::HTTPS), **http_options)
   end
 
   #
@@ -60,10 +72,7 @@ class DeepStack
   # Close the HTTP connection to DeepStack server
   #
   def close
-    @http_mutex.synchronize do
-      @http&.finish
-      @http = nil
-    end
+    @http.finish if @http&.started?
   end
 
   private
@@ -80,10 +89,8 @@ class DeepStack
     form_data = combine_images_and_args(images.flatten, **args)
     req = Net::HTTP::Post.new(uri)
     req.set_form(form_data, 'multipart/form-data')
-    @http_mutex.synchronize do
-      @http ||= Net::HTTP.start(uri.hostname, uri.port)
-      @http.request(req)
-    end
+    @http.start unless @http.started?
+    @http.request(req)
   end
 
   def combine_images_and_args(*images, **args)

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/scene.rb

@@ -4,14 +4,15 @@ class DeepStack
   # Scene Recognition
   module Scene
     #
-    # Return
+    # Call the scene recognition API to classify an image into one of the supported scenes.
     #
     # @param [Object] image binary data or a File object
     # @param [Hash] options additional fields for DeepStack, e.g. min_confidence: 0.5
     #
-    # @return [Hash] if successful, DeepStack result hash {'label' => 'scene', 'confidence' => 2.2}
+    # @return [Hash] if successful, DeepStack result hash +{'label' => 'scene', 'confidence' => 2.2}+
     #
     # @return [nil] if error
+    #
     def identify_scene(image, **options)
       target = 'vision/scene'
       api_post(target, image, **options)

data/lib/deep_stack/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deepstack
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Jimmy Tanagra
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-11 00:00:00.000000000 Z
+date: 2022-05-12 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