gliner 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: edbbf72af6499d1823db172793f3dc183f90e445d4ae45587dc1a0cd4005c15e
-  data.tar.gz: 04d0881c074e9e84617591768c1b53767d2f509bbb7497c6bc0920bf3bac96b3
+  metadata.gz: a8e4bdddc47289f29cce2469ff6bbeecc9ef260b39f3b02f6e3e89b23e3e4e7a
+  data.tar.gz: b59ad90385c8da5b478f007f5715994c11f1f1a0b85617acc501acb8b17723aa
 SHA512:
-  metadata.gz: 0ea1480d83e383534c50d14320f5cbfcc7c7a890101f9e0492cbd486dc36e05fbebaedaeea31ccf4f8b5efb3f553349cee1b25ad890457734443054d7e1dfb91
-  data.tar.gz: da1f798fd89bcaad28a41e67ec2f07e779e8a7d2681ac3d4790f2e27b2adfcfcc02f5c42e7b02c8eb7bc519fea4178f16bad6050576543dde241e8becd18dbec
+  metadata.gz: 072cc980f4653d74da83d3cfea1b09d0cbf8e023bfb6d3829ce6879163b7dc77a170ef63ad68138eca7d892521f30eda8d0be6c72e62cbe0353732aa4542bab3
+  data.tar.gz: fb84732285ff71edad266533cfd513d51036c709a4c5275fdc6548a373f11ead86eb66978fd0b28522c567af52e7d2ce8111053d721ec6ddcee6546db8bf58ed

data/README.md

@@ -1,9 +1,9 @@
-# Gliner
+# GLiNER
+[![tests](https://github.com/elcuervo/gliner/actions/workflows/tests.yml/badge.svg)](https://github.com/elcuervo/gliner/actions/workflows/tests.yml)
+![Gem Version](https://img.shields.io/gem/v/gliner)
 
 ![](https://images.unsplash.com/photo-1625768376503-68d2495d78c5?q=80&w=2225&auto=format&fit=crop&ixlib=rb-4.1.0&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D)
 
-Minimal Ruby inference wrapper for the **GLiNER2** ONNX model using:
-
 ## Install
 
 ```ruby
@@ -11,63 +11,65 @@ gem "gliner"
 ```
 
 ## Usage
-### entities
+
+### Entities
 
 ```ruby
 require "gliner"
 
-Gliner.load("path/to/gliner2-multi-v1")
+Gliner.configure do |config|
+  config.threshold = 0.2
+  # If unset, auto! downloads the default model to .cache/
+  # Or set a local path explicitly:
+  # config.model = "/path/to/gliner2-multi-v1"
+  config.variant = :fp16
+  config.auto!
+end
 
 text = "Apple CEO Tim Cook announced iPhone 15 in Cupertino yesterday."
 labels = ["company", "person", "product", "location"]
 
 model = Gliner[labels]
 pp model[text]
-```
 
-Expected shape:
-
-```ruby
-{"entities"=>{"company"=>["Apple"], "person"=>["Tim Cook"], "product"=>["iPhone 15"], "location"=>["Cupertino"]}}
+# => {"company"=>["Apple"], "person"=>["Tim Cook"], "product"=>["iPhone 15"], "location"=>["Cupertino"]}
 ```
 
 You can also pass per-entity configs:
 
 ```ruby
 labels = {
-  "email" => { "description" => "Email addresses", "dtype" => "list", "threshold" => 0.9 },
-  "person" => { "description" => "Person names", "dtype" => "str" }
+  email: { description: "Email addresses", dtype: "list", threshold: 0.9 },
+  person: { description: "Person names", dtype: "str" }
 }
 
 model = Gliner[labels]
 pp model["Email John Doe at john@example.com.", threshold: 0.5]
+
+# => {"email"=>["john@example.com"], "person"=>"John Doe"}
 ```
 
-### classification
+### Classification
 
 ```ruby
 model = Gliner.classify[
-  { "sentiment" => %w[positive negative neutral] }
+  { sentiment: %w[positive negative neutral] }
 ]
 
 result = model["This laptop has amazing performance but terrible battery life!"]
 
 pp result
-```
 
-Expected shape:
-
-```ruby
-{"sentiment"=>"negative"}
+# => {"sentiment"=>"negative"}
 ```
 
-### structured extraction
+### Structured extraction
 
 ```ruby
 text = "iPhone 15 Pro Max with 256GB storage, A17 Pro chip, priced at $1199."
 
 structure = {
-  "product" => [
+  product: [
     "name::str::Full product name and model",
     "storage::str::Storage capacity",
     "processor::str::Chip or processor information",
@@ -78,18 +80,16 @@ structure = {
 result = Gliner[structure][text]
 
 pp result
-```
-
-Expected shape:
 
-```ruby
-{"product"=>[{"name"=>"iPhone 15 Pro Max", "storage"=>"256GB", "processor"=>"A17 Pro chip", "price"=>"$1199"}]}
+# => {"product"=>[{"name"=>"iPhone 15 Pro Max", "storage"=>"256GB", "processor"=>"A17 Pro", "price"=>"1199"}]}
 ```
 
 Choices can be included in field specs:
 
 ```ruby
-result = Gliner[{ "order" => ["status::[pending|processing|shipped]::str"] }]["Status: shipped"]
+result = Gliner[{ order: ["status::[pending|processing|shipped]::str"] }]["Status: shipped"]
+
+# => {"order"=>[{"status"=>"shipped"}]}
 ```
 
 ## Model files
@@ -97,10 +97,21 @@ result = Gliner[{ "order" => ["status::[pending|processing|shipped]::str"] }]["S
 This implementation expects a directory containing:
 
 - `tokenizer.json`
-- `model.onnx` or `model_int8.onnx`
+- `model.onnx`, `model_fp16.onnx`, or `model_int8.onnx`
 - (optional) `config.json` with `max_width` and `max_seq_len`
 
 One publicly available ONNX export is `cuerbot/gliner2-multi-v1` on Hugging Face.
+By default, `model_fp16.onnx` is used; set `config.variant` (or `GLINER_MODEL_FILE`) to override.
+Variants map to files as: `:fp16` → `model_fp16.onnx`, `:fp32` → `model.onnx`, `:int8` → `model_int8.onnx`.
+
+You can also configure the model source directly:
+
+```ruby
+Gliner.configure do |config|
+  config.model = "/path/to/model_dir"
+  config.variant = :int8
+end
+```
 
 ## Integration test
 
@@ -135,7 +146,7 @@ If you omit `MODEL_DIR`, the console auto-downloads a public test model (configu
 ```bash
 rake console
 # or:
-GLINER_REPO_ID=cuerbot/gliner2-multi-v1 GLINER_MODEL_FILE=model_int8.onnx rake console
+GLINER_REPO_ID=cuerbot/gliner2-multi-v1 GLINER_MODEL_FILE=model_fp16.onnx rake console
 ```
 
 Or:

data/bin/console

@@ -12,13 +12,15 @@ require "httpx"
 require "irb"
 
 DEFAULT_REPO_ID = "cuerbot/gliner2-multi-v1"
-DEFAULT_MODEL_FILE = "model_int8.onnx"
+DEFAULT_MODEL_FILE = "model_fp16.onnx"
+DEFAULT_MODEL_SUBDIR = "onnx"
 
-def ensure_model_dir!(repo_id:, model_file:)
+def ensure_model_dir!(repo_id:, model_file:, model_subdir:)
   dir = File.expand_path("../tmp/models/#{repo_id.tr('/', '__')}", __dir__)
   FileUtils.mkdir_p(dir)
 
   base = "https://huggingface.co/#{repo_id}/resolve/main"
+  base = "#{base}/#{model_subdir}" unless model_subdir.nil? || model_subdir.empty?
   files = ["tokenizer.json", "config.json", model_file]
 
   files.each do |file|
@@ -40,13 +42,14 @@ end
 model_dir = ARGV[0] || ENV["GLINER_MODEL_DIR"]
 repo_id = ENV["GLINER_REPO_ID"] || DEFAULT_REPO_ID
 model_file = ENV["GLINER_MODEL_FILE"] || DEFAULT_MODEL_FILE
+model_subdir = ENV["GLINER_MODEL_SUBDIR"] || DEFAULT_MODEL_SUBDIR
 
 if model_dir && !model_dir.empty?
   $gliner_model = Gliner.load(model_dir, file: model_file)
 else
   begin
     require "fileutils"
-    model_dir = ensure_model_dir!(repo_id: repo_id, model_file: model_file)
+    model_dir = ensure_model_dir!(repo_id: repo_id, model_file: model_file, model_subdir: model_subdir)
     $gliner_model = Gliner.load(model_dir, file: model_file)
   rescue => e
     warn "No model loaded (auto-download failed: #{e.class}: #{e.message})"

data/gliner.gemspec

@@ -11,16 +11,18 @@ Gem::Specification.new do |spec|
   spec.description = 'Basic Ruby inference wrapper for the GLiNER2 ONNX model.'
   spec.homepage = 'https://github.com/elcuervo/gliner'
   spec.license = 'MIT'
-  spec.required_ruby_version = '>= 3.2'
+  spec.required_ruby_version = '>= 3.3'
 
   spec.files = Dir.glob('lib/**/*') + Dir.glob('bin/*') + %w[README.md LICENSE gliner.gemspec]
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'httpx', '~> 1.0'
   spec.add_dependency 'onnxruntime', '~> 0.10'
   spec.add_dependency 'tokenizers', '~> 0.6'
 
-  spec.add_development_dependency 'httpx', '~> 1.0'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.13'
   spec.add_development_dependency 'rubocop', '~> 1.50'
+
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end

data/lib/gliner/configuration.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Gliner
+  class Configuration
+    DEFAULT_THRESHOLD = 0.5
+
+    attr_accessor :threshold, :model
+    attr_reader :variant
+
+    def initialize
+      @threshold = DEFAULT_THRESHOLD
+      @model = nil
+      @variant = :fp16
+      @auto = false
+    end
+
+    def variant=(value)
+      @variant = value&.to_sym
+    end
+
+    def auto!(value = true)
+      @auto = !!value
+    end
+
+    def auto=(value)
+      @auto = !!value
+    end
+
+    def auto?
+      @auto
+    end
+  end
+end

data/lib/gliner/model.rb

@@ -22,7 +22,7 @@ module Gliner
     DEFAULT_MAX_WIDTH = 8
     DEFAULT_MAX_SEQ_LEN = 512
 
-    def self.from_dir(dir, file: 'model_int8.onnx')
+    def self.from_dir(dir, file: 'model_fp16.onnx')
       config_path = File.join(dir, 'config.json')
       config = File.exist?(config_path) ? JSON.parse(File.read(config_path)) : {}
 
@@ -100,7 +100,7 @@ module Gliner
     end
 
     def extract_entities(text, entity_types, **options)
-      threshold = options.fetch(:threshold, 0.5)
+      threshold = options.fetch(:threshold, Gliner.config.threshold)
       include_confidence = options.fetch(:include_confidence, false)
       include_spans = options.fetch(:include_spans, false)
 
@@ -125,7 +125,7 @@ module Gliner
     end
 
     def extract_json(text, structures, **options)
-      threshold = options.fetch(:threshold, 0.5)
+      threshold = options.fetch(:threshold, Gliner.config.threshold)
       include_confidence = options.fetch(:include_confidence, false)
       include_spans = options.fetch(:include_spans, false)
 

data/lib/gliner/tasks/entity_extraction.rb

@@ -29,7 +29,7 @@ module Gliner
       end
 
       def process_output(logits, parsed, prepared, options)
-        threshold = options.fetch(:threshold, 0.5)
+        threshold = options.fetch(:threshold, Gliner.config.threshold)
         format_opts = FormatOptions.from(options)
         label_positions = options[:label_positions] || inference.label_positions_for(prepared.word_ids, parsed[:labels].length)
 

data/lib/gliner/tasks/json_extraction.rb

@@ -83,7 +83,7 @@ module Gliner
           parsed[:labels],
           label_positions,
           prepared,
-          threshold: options.fetch(:threshold, 0.5)
+          threshold: options.fetch(:threshold, Gliner.config.threshold)
         )
       end
     end

data/lib/gliner/version.rb

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

data/lib/gliner.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
+require 'fileutils'
+require 'httpx'
 require 'gliner/version'
+require 'gliner/configuration'
 require 'gliner/model'
 require 'gliner/runners/prepared_task'
 require 'gliner/runners/entity_runner'
@@ -8,6 +11,11 @@ require 'gliner/runners/structured_runner'
 require 'gliner/runners/classification_runner'
 
 module Gliner
+  HF_REPO = 'cuerbot/gliner2-multi-v1'
+  HF_DIR = 'onnx'
+
+  DEFAULT_MODEL_BASE = "https://huggingface.co/#{HF_REPO}/resolve/main/#{HF_DIR}".freeze
+
   Error = Class.new(StandardError)
 
   PreparedInput = Data.define(
@@ -40,43 +48,62 @@ module Gliner
   end
 
   class << self
-    attr_writer :model
+    attr_writer :model, :config
 
-    def load(dir, file: 'model_int8.onnx')
-      self.model = Model.from_dir(dir, file: file)
+    def configure
+      yield(config)
+
+      reset_model!
+      apply_model_source!
     end
 
-    def model
-      @model ||= model_from_env
+    def config
+      @config ||= Configuration.new
     end
 
-    def model!
-      fetch_model!
+    def load(dir, file: nil)
+      file ||= ENV['GLINER_MODEL_FILE'] || model_file_for_variant(config.variant)
+
+      self.model = Model.from_dir(dir, file: file)
+    end
+
+    def model
+      @model ||= model_from_config || model_from_env
     end
 
     def [](config)
-      runner_for(config).new(fetch_model!, config)
+      runner_for(config).new(model!, config)
     end
 
     def classify
       Runners::ClassificationRunner
     end
 
+    def model!
+      model = self.model
+
+      return model if model
+
+      raise Error, 'No model loaded. Call Gliner.load("/path/to/model"), set config.model, or set GLINER_MODEL_DIR.'
+    end
+
     private
 
-    def model_from_env
-      dir = ENV.fetch('GLINER_MODEL_DIR', nil)
-      return nil if dir.nil? || dir.empty?
+    def model_from_config
+      source = config.model
+      return nil if source.nil?
 
-      file = ENV['GLINER_MODEL_FILE'] || 'model_int8.onnx'
-      Model.from_dir(dir, file: file)
+      file = model_file_for_variant(config.variant)
+      Model.from_dir(source, file: file)
     end
 
-    def fetch_model!
-      model = self.model
-      return model if model
+    def model_from_env
+      dir = ENV.fetch('GLINER_MODEL_DIR', nil)
+      return if dir.nil?
 
-      raise Error, 'No model loaded. Call Gliner.load("/path/to/model") or set GLINER_MODEL_DIR.'
+      file = ENV['GLINER_MODEL_FILE'] || model_file_for_variant(config.variant)
+
+      Model.from_dir(dir, file: file)
     end
 
     def runner_for(config)
@@ -89,9 +116,53 @@ module Gliner
       return false unless config.is_a?(Hash)
 
       keys = config.transform_keys(&:to_s)
+
       return true if keys.key?('name') && keys.key?('fields')
 
       config.values.all? { |value| value.is_a?(Array) }
     end
+
+    def reset_model!
+      @model = nil
+    end
+
+    def apply_model_source!
+      return unless config.auto?
+
+      source = config.model
+      return unless source.nil? || source.empty?
+
+      config.model = download_default_model
+    end
+
+    def download_default_model
+      model_file = model_file_for_variant(config.variant)
+      root = File.expand_path('..', __dir__)
+      dir = File.join(root, '.cache', 'models', HF_REPO.tr('/', '__'))
+
+      FileUtils.mkdir_p(dir)
+
+      files = ['tokenizer.json', 'config.json', model_file]
+      client = HTTPX.plugin(:follow_redirects)
+
+      files.each do |file|
+        response = client.get("#{DEFAULT_MODEL_BASE}/#{file}")
+        raise Error, "Download failed: #{file}" if response.error?
+
+        File.binwrite(File.join(dir, file), response.body.to_s)
+      end
+
+      dir
+    end
+
+    def model_file_for_variant(variant = :fp16)
+      case variant.to_sym
+      when :fp16 then 'model_fp16.onnx'
+      when :fp32 then 'model.onnx'
+      when :int8 then 'model_int8.onnx'
+      else
+        raise Error, "Unknown model variant: #{variant.inspect}"
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gliner
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - elcuervo
@@ -10,47 +10,47 @@ cert_chain: []
 date: 1980-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: onnxruntime
+  name: httpx
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: tokenizers
+  name: onnxruntime
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.10'
 - !ruby/object:Gem::Dependency
-  name: httpx
+  name: tokenizers
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
+        version: '0.6'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +108,7 @@ files:
 - lib/gliner/config/entity_types.rb
 - lib/gliner/config/field_spec.rb
 - lib/gliner/config_parser.rb
+- lib/gliner/configuration.rb
 - lib/gliner/inference.rb
 - lib/gliner/inference/session_validator.rb
 - lib/gliner/input_builder.rb
@@ -129,7 +130,8 @@ files:
 homepage: https://github.com/elcuervo/gliner
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -137,14 +139,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.2'
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.2
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Schema-based information extraction (GLiNER2) via ONNX Runtime
 test_files: []