hugging-face 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 81267c0c030b98028e201d0f52471d12a2aea6f6fe519354534522528e331d02
-  data.tar.gz: 235e128fdd8c7f534aace15ff606f89e432cb7fd120a44f94d3fc55cd4fa491a
+  metadata.gz: 053432b377155f8768a2e25521b62c0fc5fdbb3a619f45875c346c5f3c126e81
+  data.tar.gz: d8551f8263129317a2692e5b6d3994617c1ae66285ce21a78a1796a2ad5f9f85
 SHA512:
-  metadata.gz: 7d620ad3f025f8f0ccae02a266b8ee74c41c019d50e76fbf3e24688a71f213cacd6c342cea23f9854522480c2f5945b4973a5ea58fba5f860bb16c8f2244971e
-  data.tar.gz: 1aa4a1fce880f38ae5367f168cb53ce3a93cf58450ab5d8d0a7ef6f5abe316efb713a1dcc97e9e592a91ba03484c915dc73dfe7401189fd8b8ba1b8cebfafc75
+  metadata.gz: 933fad128d5ad66370e0e24271498cc9730e0f71e9ed920cf5a3107f8971bb5382586d1bc3d887b4d490b0fbbb8f0498e9b503dab4a669469bc1349824e023a3
+  data.tar.gz: 0654e009acdbea3097f00f13f7c2b4389679e52b4b15db629ca2703c4267f2e27dcbfe866ee644c9cb5c23d56a5f5960d37a18334c7d0a21ca55815941aec281

data/Gemfile

@@ -8,3 +8,4 @@ gemspec
 gem "rake", "~> 13.0"
 
 gem "rspec", "~> 3.0"
+gem "webmock", "~> 3.0"

data/Gemfile.lock

@@ -7,12 +7,19 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    addressable (2.8.4)
+      public_suffix (>= 2.0.2, < 6.0)
+    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)
+    hashdiff (1.0.1)
+    public_suffix (5.0.1)
     rake (13.0.6)
+    rexml (3.2.5)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
@@ -27,14 +34,20 @@ GEM
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)
     ruby2_keywords (0.0.5)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
   arm64-darwin-21
+  x86_64-linux
 
 DEPENDENCIES
   hugging-face!
   rake (~> 13.0)
   rspec (~> 3.0)
+  webmock (~> 3.0)
 
 BUNDLED WITH
    2.4.0

data/README.md

@@ -18,7 +18,36 @@ $ gem install hugging-face
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+require "hugging_face"
+```
+
+Instantiate a HuggigFace Inference API client:
+
+```ruby
+client = HuggingFace::InferenceApi.new(api_key: ENV['HUGGING_FACE_API_KEY'])
+```
+
+Questiion answering:
+
+```ruby
+client.question_answering(
+  question: 'What is my name?',
+  context: 'I am the only child. My father named his son John.'
+)
+```
+
+Text generation:
+
+```ruby
+client.text_generation(input: 'Can you please let us know more details about your ')
+```
+
+Summarization:
+
+```ruby
+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.')
+```
 
 ## Development
 
@@ -33,3 +62,4 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/alchap
 ## Code of Conduct
 
 Everyone interacting in the HuggingFace project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/alchaplinsky/hugging-face/blob/main/CODE_OF_CONDUCT.md).
+

data/lib/hugging_face/base_api.rb

@@ -0,0 +1,46 @@
+require 'logger'
+require 'faraday'
+
+module HuggingFace
+  class BaseApi
+    HTTP_SERVICE_UNAVAILABLE = 503
+    JSON_CONTENT_TYPE = 'application/json'
+
+    def initialize(api_token:)
+      @headers = {
+        'Authorization' => 'Bearer ' + api_token,
+        'Content-Type' => JSON_CONTENT_TYPE
+      }
+    end
+
+    private
+
+    def connection(url)
+      Faraday.new(url, headers: @headers)
+    end
+
+    def request(connection:, input:)
+      response = connection.post { |req| req.body = input.to_json }
+
+      if response.success?
+        return parse_response response
+      else
+        raise ServiceUnavailable.new response.body if response.status == HTTP_SERVICE_UNAVAILABLE
+        raise Error.new response.body
+      end
+    end
+
+    def parse_response(response)
+      if response.headers['Content-Type'] == JSON_CONTENT_TYPE
+        JSON.parse(response.body)
+      else
+        response.body
+      end
+    end
+
+    def logger
+      @logger ||= Logger.new(STDOUT)
+    end
+  end
+end
+

data/lib/hugging_face/{interface_api.rb → inference_api.rb}

@@ -1,22 +1,12 @@
-require 'faraday'
-
 module HuggingFace
-  class InterfaceApi
+  class InferenceApi < BaseApi
     HOST = "https://api-inference.huggingface.co"
-    MAX_RETRY = 2
-    HTTP_SEVICE_UNAVAILABLE = 503
+    MAX_RETRY = 20
 
     QUESTION_ANSWERING_MODEL = 'distilbert-base-cased-distilled-squad'
     SUMMARIZATION_MODEL = "sshleifer/distilbart-xsum-12-6"
     GENERATION_MODEL = "distilgpt2"
 
-    def initialize(api_token:)
-      @headers = {
-        'Authorization' => 'Bearer ' + api_token,
-        'Content-Type' => 'application/json'
-      }
-    end
-
     def call(input:, model:)
       request(connection: connection(model), input: input)
     end
@@ -37,27 +27,26 @@ module HuggingFace
 
     private
 
+    def connection(model)
+      super "#{HOST}/models/#{model}"
+    end
+
     def request(connection:, input:)
       retries = 0
-      while retries < MAX_RETRY
-        response = connection.post { |req| req.body = input.to_json }
 
-        break if response.success?
+      begin
+        return super(connection: connection, input: input)
+      rescue ServiceUnavailable => exception
 
-        if response.status == HTTP_SEVICE_UNAVAILABLE
+        if retries < MAX_RETRY
+          logger.debug('Service unavailable, retrying...')
           retries += 1
           sleep 1
-          redo
+          retry
+        else
+          raise exception
         end
-
-        raise "Error: #{response.body}"
       end
-
-      return JSON.parse(response.body)
-    end
-
-    def connection(model)
-      Faraday.new(url: "#{HOST}/models/#{model}" , headers: @headers)
     end
   end
 end

data/lib/hugging_face/version.rb

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

data/lib/hugging_face.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
 require_relative "hugging_face/version"
-require_relative "hugging_face/interface_api"
+require_relative "hugging_face/base_api"
+require_relative "hugging_face/inference_api"
 
 module HuggingFace
   class Error < StandardError; end
+  class ServiceUnavailable < Error; end
   # Your code goes here...
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hugging-face
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Alex Chaplinsky
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-15 00:00:00.000000000 Z
+date: 2023-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -39,7 +39,8 @@ files:
 - README.md
 - Rakefile
 - lib/hugging_face.rb
-- lib/hugging_face/interface_api.rb
+- lib/hugging_face/base_api.rb
+- lib/hugging_face/inference_api.rb
 - lib/hugging_face/version.rb
 - sig/hugging_face.rbs
 homepage: https://rubygems.org/gems/hugging-face