hugging-face 0.3.3 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b1fd1e517f21466be454d55dcc88e0344acaa6fd91900335615f632b734595e
-  data.tar.gz: c865080f1350cc0e056f0ff190b6c99373cc32a287bb9c0e558ce777456ca057
+  metadata.gz: e332f1b35fbd0fb35cae8001b5fa7ecae8aeb0326f49d63f7d9bba8872ae1df9
+  data.tar.gz: 895a1b725527941626559dc30d85b54204a3e9c2b06d196f3d061108eac5b8df
 SHA512:
-  metadata.gz: 803618ef477824cafbf3b5d37e76d3bcfcc6b9cfd90632e55df733f9b7f14d7ef6e4d5403ce9f1828f6459ee32b511783c2d8f3217caf7ba3ee87123f0372754
-  data.tar.gz: 62cfb9bb3f0f6905f9963d7997b7deecabdda75a0771f8625604bde1dd7c883ab76bc43e811355b99f26428d0ae84397deb1a5741824fa3c32fcd0e80fa6cc1c
+  metadata.gz: d55632ba6532b38545db4664ce8529cbb942fc41d65a7810251a04c2add4a8637311df1c2a4af91f76e3c2707dda7625104af6ad0fa9d36412f334bc27825c5c
+  data.tar.gz: 853625dc46f48785ba7fe257b44ccf34894adf03b81d8dcd0479c2f15b5e7b73f6c0459eac9725ae13214c77dd359a7ecd0f241dfa5c1658c136c920eba2fc32

data/Gemfile.lock

@@ -1,25 +1,27 @@
 PATH
   remote: .
   specs:
-    hugging-face (0.3.3)
-      faraday (~> 1.0)
+    hugging-face (0.3.5)
+      faraday (>= 1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.8.4)
+    addressable (2.8.5)
       public_suffix (>= 2.0.2, < 6.0)
+    base64 (0.1.1)
     crack (0.4.5)
       rexml
     diff-lcs (1.5.0)
-    faraday (1.2.0)
-      multipart-post (>= 1.2, < 3)
-      ruby2_keywords
+    faraday (2.7.11)
+      base64
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.2)
     hashdiff (1.0.1)
-    multipart-post (2.3.0)
-    public_suffix (5.0.1)
+    public_suffix (5.0.3)
     rake (13.0.6)
-    rexml (3.2.5)
+    rexml (3.2.6)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
@@ -29,18 +31,19 @@ GEM
     rspec-expectations (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.5)
+    rspec-mocks (3.12.6)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-support (3.12.0)
+    rspec-support (3.12.1)
     ruby2_keywords (0.0.5)
-    webmock (3.18.1)
+    webmock (3.19.1)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
   arm64-darwin-21
+  arm64-darwin-22
   x86_64-darwin-19
   x86_64-linux
 

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Alex Chaplinsky
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -18,14 +18,19 @@ $ gem install hugging-face
 
 ## Usage
 
+
+### Inference API
+
+The inference API is a free Machine Learning API from Hugging Face. It is meant for prototyping and not produciton use, see below for Inference Endpoints, the product for use with production LLMs.
+
 ```ruby
 require "hugging_face"
 ```
 
-Instantiate a HuggigFace Inference API client:
+Instantiate a HuggingFace Inference API client:
 
 ```ruby
-client = HuggingFace::InferenceApi.new(api_key: ENV['HUGGING_FACE_API_KEY'])
+client = HuggingFace::InferenceApi.new(api_token: ENV['HUGGING_FACE_API_TOKEN'])
 ```
 
 Question answering:
@@ -55,6 +60,40 @@ Embedding:
 client.embedding(input: ['How to build a ruby gem?', 'How to install ruby gem?'])
 ```
 
+Sentiment:
+
+```ruby
+client.sentiment(input: ['My life sucks', 'Life is a miracle'])
+```
+
+### Inference Endpoints
+
+With this same gem, you can also access endpoints, which are best described by Hugging Face: "[Inference Endpoints](https://huggingface.co/docs/inference-endpoints/index) provides a secure production solution to easily deploy models on a dedicated and autoscaling infrastructure managed by Hugging Face. An Inference Endpoint is built from a model from the Hub."
+
+Once you've created an endpoint by choosing a model and desired infrastructure, you'll be given an endpoint URL, something like: https://eyic1edp3ah0g5ln.us-east-1.aws.endpoints.huggingface.cloud
+
+You'll need your token to access your endpoint if you've chosen for it to be protected. You can also choose to have a public endpoint.
+
+Since you choose the LLM task in your endpoint config (e.g. Text Classification, Summarisation, Question answering), there is no need to pass that argument.
+
+To access from the gem. instantiate a HuggingFace Endpoint API client:
+
+```ruby
+endpoint = HuggingFace::EndpointsApi.new(api_token: ENV['HUGGING_FACE_API_TOKEN'])
+```
+
+Example with input from question answering task:
+
+```ruby
+endpoint.request(endpoint_url: "https://your-end-point.us-east-1.aws.endpoints.huggingface.cloud", input: { context: some_text, question: question } 
+```
+
+Example call to an endpoint configured for summarisation, including passing params:
+
+```ruby
+endpoint.request(endpoint_url: "https://your-end-point.us-east-1.aws.endpoints.huggingface.cloud", input: some_text, params: { min_length:  32, max_length: 64 } )
+```
+
 
 ## Development
 

data/lib/hugging_face/base_api.rb

@@ -20,9 +20,12 @@ module HuggingFace
       Faraday.new(url, headers: @headers)
     end
 
-    def request(connection:, input:)
-      response = connection.post { |req| req.body = input.to_json }
-
+    def request(connection:, input:, params: nil)
+      response = connection.post { |req| 
+        req.body = input.to_json 
+        req.params = params if params
+      }
+      
       if response.success?
         return parse_response response
       else

data/lib/hugging_face/endpoints_api.rb

@@ -0,0 +1,29 @@
+module HuggingFace
+  class EndpointsApi < BaseApi
+
+    def request(endpoint_url:, input:, params: nil)
+      retries = 0
+
+      endpoint_connection = build_connection endpoint_url
+
+      begin
+        return super(connection: endpoint_connection, input: { inputs: input }, params: params )
+      rescue ServiceUnavailable => exception
+
+        if retries < MAX_RETRY
+          logger.debug('Service unavailable, retrying...')
+          retries += 1
+          sleep 5
+          retry
+        else
+          raise exception
+        end
+      end
+    end  
+        
+
+    private
+
+
+  end
+end

data/lib/hugging_face/inference_api.rb

@@ -5,11 +5,12 @@ module HuggingFace
     # Retry connecting to the model for 1 minute
     MAX_RETRY = 60
 
-    # Deafult models that can be overriden by 'model' param
+    # Default 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"
+    SENTIMENT_MODEL = "distilbert-base-uncased-finetuned-sst-2-english"
 
     def call(input:, model:)
       request(connection: connection(model), input: input)
@@ -33,6 +34,11 @@ module HuggingFace
       request connection: connection(model), input: { inputs: input }
     end
 
+    def sentiment(input:, model: SENTIMENT_MODEL)
+      request connection: connection(model), input: { inputs: input }
+    end    
+        
+
     private
 
     def connection(model)

data/lib/hugging_face/version.rb

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

data/lib/hugging_face.rb

@@ -3,6 +3,7 @@
 require_relative "hugging_face/version"
 require_relative "hugging_face/base_api"
 require_relative "hugging_face/inference_api"
+require_relative "hugging_face/endpoints_api"
 
 module HuggingFace
   class Error < StandardError; end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: hugging-face
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.5
 platform: ruby
 authors:
 - Alex Chaplinsky
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-16 00:00:00.000000000 Z
+date: 2024-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
 description: Ruby client for Hugging Face API
@@ -36,10 +36,12 @@ files:
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
+- LICENSE
 - README.md
 - Rakefile
 - lib/hugging_face.rb
 - lib/hugging_face/base_api.rb
+- lib/hugging_face/endpoints_api.rb
 - lib/hugging_face/inference_api.rb
 - lib/hugging_face/version.rb
 - sig/hugging_face.rbs
@@ -64,7 +66,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: Ruby client for Hugging Face API