hugging-face 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 053432b377155f8768a2e25521b62c0fc5fdbb3a619f45875c346c5f3c126e81
-  data.tar.gz: d8551f8263129317a2692e5b6d3994617c1ae66285ce21a78a1796a2ad5f9f85
+  metadata.gz: 9b9591169889f3b463224dade2fa11e63bba1733d6e09ebb814e9e9e1d5bad14
+  data.tar.gz: 521110a79c57838d68aff92db3212358bcda75484b55a78c92ea46272fbc41d2
 SHA512:
-  metadata.gz: 933fad128d5ad66370e0e24271498cc9730e0f71e9ed920cf5a3107f8971bb5382586d1bc3d887b4d490b0fbbb8f0498e9b503dab4a669469bc1349824e023a3
-  data.tar.gz: 0654e009acdbea3097f00f13f7c2b4389679e52b4b15db629ca2703c4267f2e27dcbfe866ee644c9cb5c23d56a5f5960d37a18334c7d0a21ca55815941aec281
+  metadata.gz: 9940b1ec90fdb03631d3318f1f12bf6431132166d97adbb9e3e962f6acf7e2150982da478129cee4c2d2bb4bdb973f9dda2b7e837c4722ad2d9b09d122205172
+  data.tar.gz: 4d9076507fcc8b3f6829aeb34d462fda23a317b8b2009a94be73cceb33b255f871ece5a0d0b41a832b743b4c26e7aa6af9d589f0eb3c112b96d4760ac56434b4

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    hugging-face (0.1.0)
-      faraday (~> 2.7)
+    hugging-face (0.3.1)
+      faraday (~> 1.0)
 
 GEM
   remote: https://rubygems.org/
@@ -12,11 +12,11 @@ GEM
     crack (0.4.5)
       rexml
     diff-lcs (1.5.0)
-    faraday (2.7.4)
-      faraday-net_http (>= 2.0, < 3.1)
-      ruby2_keywords (>= 0.0.4)
-    faraday-net_http (3.0.2)
+    faraday (1.2.0)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords
     hashdiff (1.0.1)
+    multipart-post (2.3.0)
     public_suffix (5.0.1)
     rake (13.0.6)
     rexml (3.2.5)
@@ -41,6 +41,7 @@ GEM
 
 PLATFORMS
   arm64-darwin-21
+  x86_64-darwin-19
   x86_64-linux
 
 DEPENDENCIES

data/README.md

@@ -28,7 +28,7 @@ Instantiate a HuggigFace Inference API client:
 client = HuggingFace::InferenceApi.new(api_key: ENV['HUGGING_FACE_API_KEY'])
 ```
 
-Questiion answering:
+Question answering:
 
 ```ruby
 client.question_answering(
@@ -49,6 +49,13 @@ Summarization:
 client.summarization(input: 'The tower is 324 metres (1,063 ft) tall, about the same height as an 81-storey building, and the tallest structure in Paris. Its base is square, measuring 125 metres (410 ft) on each side. During its construction, the Eiffel Tower surpassed the Washington Monument to become the tallest man-made structure in the world, a title it held for 41 years until the Chrysler Building in New York City was finished in 1930.')
 ```
 
+Embedding:
+
+```ruby
+client.embedding(input: ['How to build a ruby gem?', 'How to install ruby gem?'])
+```
+
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/hugging_face/base_api.rb

@@ -15,7 +15,7 @@ module HuggingFace
 
     private
 
-    def connection(url)
+    def build_connection(url)
       Faraday.new(url, headers: @headers)
     end
 

data/lib/hugging_face/inference_api.rb

@@ -1,11 +1,15 @@
 module HuggingFace
   class InferenceApi < BaseApi
     HOST = "https://api-inference.huggingface.co"
-    MAX_RETRY = 20
 
+    # Retry connecting to the model for 1 minute
+    MAX_RETRY = 60
+
+    # Deafult models that can be overriden by 'model' param
     QUESTION_ANSWERING_MODEL = 'distilbert-base-cased-distilled-squad'
     SUMMARIZATION_MODEL = "sshleifer/distilbart-xsum-12-6"
     GENERATION_MODEL = "distilgpt2"
+    EMBEDING_MODEL = "sentence-transformers/all-MiniLM-L6-v2"
 
     def call(input:, model:)
       request(connection: connection(model), input: input)
@@ -14,21 +18,29 @@ module HuggingFace
     def question_answering(question:, context:, model: QUESTION_ANSWERING_MODEL)
       input = { question: question, context: context }
 
-      request(connection: connection(model), input: input)
+      request connection: connection(model), input: input
     end
 
     def summarization(input:, model: SUMMARIZATION_MODEL)
-      request(connection: connection(model), input: { inputs: input })
+      request connection: connection(model), input: { inputs: input }
     end
 
     def text_generation(input:, model: GENERATION_MODEL)
-      request(connection: connection(model), input: { inputs: input })
+      request connection: connection(model), input: { inputs: input }
+    end
+
+    def embedding(input:)
+      request connection: connection(EMBEDING_MODEL), input: { inputs: input }
     end
 
     private
 
     def connection(model)
-      super "#{HOST}/models/#{model}"
+      if model == EMBEDING_MODEL
+        build_connection "#{HOST}/pipeline/feature-extraction/#{model}"
+      else
+        build_connection "#{HOST}/models/#{model}"
+      end
     end
 
     def request(connection:, input:)

data/lib/hugging_face/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module HuggingFace
-  VERSION = "0.2.0"
+  VERSION = "0.3.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hugging-face
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Alex Chaplinsky
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '1.0'
 description: Ruby client for Hugging Face API
 email:
 - alchaplinsky@gmail.com