ollama-ruby 1.23.1 → 1.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f197227ddcc162704a67a9cc17c97fd2b79d5771a96f3ebf20b11439c2a74c76
-  data.tar.gz: 0d7ce28a20d917d972091270e09a1000436788a5ad65ce9c9992c9e5e8539d52
+  metadata.gz: 54d8913adab981adc75ef6c69fc059349fbd55249fa919d94b52fdf19985554b
+  data.tar.gz: f4df502f748953d6ca799ec58cebf1f04d507d554fa68c1b5262e90b2a2b75b0
 SHA512:
-  metadata.gz: 44315e4d097b7866b0fbbed812d950c8e40b0ede380223561716d0a9f223fd74407afa803f2df5ad43f64cf3f620a8adabb0e4ba506518601036e78a0f1c194b
-  data.tar.gz: b35bd622e71e8d6f79909c46c09a71792d8dac7cc37286de7b39049422f9e9fbca835d3f8e654926afc7ff84df628129a67bf63492953c49b55b735907a58915
+  metadata.gz: 4eacd7afe3fed35b8d49e16ebdc37297d8a1084ea31060d55a6710dc1f84479e4b0a41f251048d1d3292bf05f244b4eb0bccb9250c6f97735006df94a9a593e1
+  data.tar.gz: 4af350efba4685daea10c6c9edc9b5399fb1e4cf8b39302c1a532aeb0ed7dc9dfda149b686838115d757aa7f1f24d5a19a882cc7d1f869e478d3531e02cd2ff2

data/CHANGES.md

@@ -1,5 +1,34 @@
 # Changes
 
+## 2026-10-16 v1.24.0
+
+*   Add `Options.from_string` to parse `show`-format parameter strings with
+    type inference for `Boolean`, `Integer`, `Float`, and `Array` types.
+*   Add `draft_num_predict: Integer` to the `@@types` registry and freeze the
+    `@@types` hash to prevent accidental mutation.
+*   Fix an infinite loop in `bin/ollama_ps` by correcting the `while` condition
+    to `duration > 0` and ensuring explicit exit codes (`exit 0` for success,
+    `exit 1` for failure).
+*   Add `rescue Interrupt` handling in `bin/ollama_ps` for clean `Ctrl+C` exit
+    messages.
+*   Update YARD documentation for the `think` parameter in
+    `Ollama::Commands::Chat` and `Ollama::Commands::Generate` to include
+    `"max"` as an accepted thinking level.
+*   Document the `show` → `create` parameter import workflow in `README.md`.
+*   Add `-i INTERVAL` to the `ollama_ps` usage block in `README.md`.
+*   Fix backtick formatting for `Q4_K_M` and `F16` in the `ollama_ps` QUANT
+    column documentation.
+*   Remove vim modeline comments from `Gemfile` and `Rakefile`.
+
+## 2026-08-12 v1.23.2
+
+- Optimized terminal rendering in `bin/ollama_ps` polling loop by replacing
+  `clear_screen` with `move_home` and `erase_in_display(nil)` to prevent tmux
+  flicker.
+- Applied the same terminal clearing fix to streaming mode in
+  `lib/ollama/handlers/markdown.rb`.
+- Updated `gem_hadar` development dependency to **>= 2.18.0**.
+
 ## 2026-07-23 v1.23.1
 
 - Update `tins` gem dependency to **~> 1.55** in `Rakefile` and

data/Gemfile

@@ -1,5 +1,3 @@
-# vim: set filetype=ruby et sw=2 ts=2:
-
 source 'https://rubygems.org'
 
 gemspec

data/README.md

@@ -280,6 +280,16 @@ create(
 This method is highly efficient as it uses streaming uploads and avoids
 redundant data transfers if the blob already exists on the server.
 
+You can also import parameters from an existing model using the `show`
+endpoint. `Options.from_string` parses the multi-line `parameters` field into
+a typed `Options` instance that can be passed to `create(…, parameters:)`:
+
+```ruby
+info    = show(model: 'llama3.1')
+options = Options.from_string(info.parameters)
+create(model: 'my-clone', from: 'llama3.1', parameters: options)
+```
+
 ## Auxiliary objects
 
 The following objects are provided to interact with the ollama server. You can
@@ -533,6 +543,7 @@ including:
 Usage: ollama_ps [OPTIONS]
 
   -f FORMAT      output format: json, yaml, or table (default)
+  -i INTERVAL    output the ps table every INTERVAL seconds
   -h             this help
 ```
 
@@ -553,7 +564,7 @@ The script displays a formatted table with columns:
 * **PROCESSOR** - CPU/GPU allocation percentage
 * **CONTEXT** - Context window size
 * **PARAMS** - Parameter count (e.g., 30.5B, 23M)
-* **QUANT** - Quantization level (e.g., Q4_K_M, F16)
+* **QUANT** - Quantization level (e.g., `Q4_K_M`, `F16`)
 * **UNTIL** - Time until model expiration
 
 Example output:

data/Rakefile

@@ -1,5 +1,3 @@
-# vim: set filetype=ruby et sw=2 ts=2:
-
 require 'gem_hadar'
 
 GemHadar do

data/bin/ollama_ps

@@ -190,6 +190,8 @@ def ps_table(models)
   puts table
 end
 
+c = Term::ANSIColor
+
 opts = go 'f:i:h'
 
 opts[?h] and usage
@@ -204,14 +206,18 @@ when 'yaml'
 else
   duration = opts[?i].to_i.clamp(0..)
   begin
-    print Term::ANSIColor.clear_screen, Term::ANSIColor.move_home if duration > 0
+    print c.move_home, c.erase_in_display(nil) if duration > 0
     if models = fetch_ps_models.full?
       ps_table(interpret_models(models))
     end
-    duration == 0 and break
+    duration == 0 and exit 0
     sleep duration
+  rescue Interrupt
+    puts "\n *** Interrupted."
+    exit 0
   rescue => e
     warn "Caught #{e.class}: #{e}"
     sleep duration
-  end while duration
+  end while duration > 0
+  exit 1
 end

data/lib/ollama/commands/chat.rb

@@ -40,7 +40,7 @@ class Ollama::Commands::Chat
   # @param stream [ TrueClass, FalseClass, nil ] whether to enable streaming for the operation
   # @param keep_alive [ String, nil ] duration to keep the model loaded in memory
   # @param think [ Boolean, String, nil ] whether to enable thinking mode for
-  #   generation. Can be "high", "medium", "low" instead of true
+  #   generation. Can be "max", "high", "medium", "low" instead of true
   def initialize(model:, messages:, tools: nil, format: nil, options: nil, stream: nil, keep_alive: nil, think: nil)
     @model, @messages, @tools, @format, @options, @stream, @keep_alive, @think =
       model, as_array_of_hashes(messages), as_array_of_hashes(tools),

data/lib/ollama/commands/generate.rb

@@ -43,7 +43,7 @@ class Ollama::Commands::Generate
   # @param raw [ Boolean, nil ] whether to return raw output without formatting
   # @param keep_alive [ String, nil ] duration to keep the model loaded in memory
   # @param think [ Boolean, String, nil ] whether to enable thinking mode for
-  #   generation. Can be "high", "medium", "low" instead of true
+  #   generation. Can be "max", "high", "medium", "low" instead of true
   def initialize(model:, prompt:, suffix: nil, images: nil, format: nil, options: nil, system: nil, template: nil, context: nil, stream: nil, raw: nil, keep_alive: nil, think: nil)
     @model, @prompt, @suffix, @images, @format, @options, @system, @template, @context, @stream, @raw, @keep_alive, @think =
       model, prompt, suffix, (Array(images) if images), format, options, system, template, context, stream, raw, keep_alive, think

data/lib/ollama/handlers/markdown.rb

@@ -45,7 +45,7 @@ class Ollama::Handlers::Markdown
       if @stream
         @content << content
         markdown_content = Kramdown::ANSI.parse(@content)
-        @output.print clear_screen, move_home, markdown_content
+        @output.print move_home, erase_in_display(nil), markdown_content
       else
         markdown_content = Kramdown::ANSI.parse(content)
         @output.print markdown_content

data/lib/ollama/options.rb

@@ -68,6 +68,9 @@ class Ollama::Options
     # Maximum number of tokens to predict - limits generation length
     num_predict:       Integer,
 
+    # Number of tokens for draft model - speculative decoding
+    draft_num_predict: Integer,
+
     # Top-K sampling - limits sampling to top K tokens
     top_k:             Integer,
 
@@ -112,7 +115,7 @@ class Ollama::Options
 
     # Stop sequences - array of strings that will stop generation
     stop:              Array,
-  }
+  }.freeze
 
   @@types.each do |name, type|
     attr_reader name
@@ -158,4 +161,51 @@ class Ollama::Options
   def self.[](value)
     new(**value.to_h)
   end
+
+  # The from_string method creates a new instance of the class from a
+  # multi-line parameter string.
+  #
+  # This class method parses a string in the format used by the Ollama
+  # `show` endpoint's `parameters` field, where each line contains a
+  # parameter name and its value separated by whitespace. It infers the
+  # Ruby type for each value (Boolean, Integer, Float) based on the
+  # pattern, and accumulates array-typed parameters (e.g. `stop`)
+  # into an array. Unknown or unparseable lines are silently skipped.
+  #
+  # @example Parsing a `show` parameter block
+  #   Options.from_string(<<~PARAMS)
+  #     temperature  0.8
+  #     top_k        40
+  #     top_p        0.9
+  #     stop <|start_header_id|>
+  #     stop <|end_header_id|>
+  #   PARAMS
+  #   # => #<Ollama::Options temperature=0.8, top_k=40, …
+  #
+  # @param string [ String ] a multi-line parameter string as returned by
+  #   the `show` endpoint's `parameters` field
+  #
+  # @return [ self ] a new instance of the class with the parsed attributes
+  def self.from_string(string)
+    self[
+      string.lines.each_with_object({}) do |l, h|
+        k, v = l.chomp.split(/\s+/, 2)
+        k    = k.to_sym
+        h[k] =
+          case v
+          when 'true'          then true
+          when 'false'         then false
+          when /\A(?:-)?\d+\z/ then Integer(v)
+          else
+            if @@types[k] == Array
+              (h[k] ||= []) << v
+            else
+              Float(v)
+            end
+          end
+      rescue
+        nil
+      end.compact
+    ]
+  end
 end

data/lib/ollama/version.rb

@@ -1,6 +1,6 @@
 module Ollama
   # Ollama version
-  VERSION         = '1.23.1'
+  VERSION         = '1.24.0'
   VERSION_ARRAY   = VERSION.split('.').map(&:to_i) # :nodoc:
   VERSION_MAJOR   = VERSION_ARRAY[0] # :nodoc:
   VERSION_MINOR   = VERSION_ARRAY[1] # :nodoc:

data/ollama-ruby.gemspec

@@ -1,9 +1,9 @@
 # -*- encoding: utf-8 -*-
-# stub: ollama-ruby 1.23.1 ruby lib
+# stub: ollama-ruby 1.24.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "ollama-ruby".freeze
-  s.version = "1.23.1".freeze
+  s.version = "1.24.0".freeze
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
@@ -18,13 +18,13 @@ Gem::Specification.new do |s|
   s.licenses = ["MIT".freeze]
   s.rdoc_options = ["--title".freeze, "Ollama-ruby - Interacting with the Ollama API".freeze, "--main".freeze, "README.md".freeze]
   s.required_ruby_version = Gem::Requirement.new(">= 3.1".freeze)
-  s.rubygems_version = "4.0.17".freeze
+  s.rubygems_version = "4.0.22".freeze
   s.summary = "Interacting with the Ollama API".freeze
   s.test_files = ["spec/ollama/client/doc_spec.rb".freeze, "spec/ollama/client_spec.rb".freeze, "spec/ollama/commands/blob_exists_spec.rb".freeze, "spec/ollama/commands/chat_spec.rb".freeze, "spec/ollama/commands/copy_spec.rb".freeze, "spec/ollama/commands/create_spec.rb".freeze, "spec/ollama/commands/delete_spec.rb".freeze, "spec/ollama/commands/embed_spec.rb".freeze, "spec/ollama/commands/embeddings_spec.rb".freeze, "spec/ollama/commands/generate_spec.rb".freeze, "spec/ollama/commands/ps_spec.rb".freeze, "spec/ollama/commands/pull_spec.rb".freeze, "spec/ollama/commands/push_blob_spec.rb".freeze, "spec/ollama/commands/push_spec.rb".freeze, "spec/ollama/commands/show_spec.rb".freeze, "spec/ollama/commands/tags_spec.rb".freeze, "spec/ollama/commands/version_spec.rb".freeze, "spec/ollama/digester_spec.rb".freeze, "spec/ollama/handlers/collector_spec.rb".freeze, "spec/ollama/handlers/dump_json_spec.rb".freeze, "spec/ollama/handlers/dump_yaml_spec.rb".freeze, "spec/ollama/handlers/markdown_spec.rb".freeze, "spec/ollama/handlers/nop_spec.rb".freeze, "spec/ollama/handlers/print_spec.rb".freeze, "spec/ollama/handlers/progress_spec.rb".freeze, "spec/ollama/handlers/say_spec.rb".freeze, "spec/ollama/handlers/single_spec.rb".freeze, "spec/ollama/image_spec.rb".freeze, "spec/ollama/message_spec.rb".freeze, "spec/ollama/options_spec.rb".freeze, "spec/ollama/tool_spec.rb".freeze, "spec/spec_helper.rb".freeze]
 
   s.specification_version = 4
 
-  s.add_development_dependency(%q<gem_hadar>.freeze, [">= 2.17.1".freeze])
+  s.add_development_dependency(%q<gem_hadar>.freeze, [">= 2.18.0".freeze])
   s.add_development_dependency(%q<all_images>.freeze, ["~> 0.12".freeze])
   s.add_development_dependency(%q<rspec>.freeze, ["~> 3.2".freeze])
   s.add_development_dependency(%q<kramdown>.freeze, ["~> 2.0".freeze])

data/spec/ollama/handlers/markdown_spec.rb

@@ -22,7 +22,7 @@ describe Ollama::Handlers::Markdown do
 
   it 'can markdown response as markdown' do
     output = double('output', :sync= => true)
-    expect(output).to receive(:print).with("\e[2J", "\e[1;1H", ansi)
+    expect(output).to receive(:print).with("\e[1;1H", "\e[J", ansi)
     markdown = described_class.new(output:)
     response = double('response', response: md, done: false)
     markdown.call(response)
@@ -32,7 +32,7 @@ describe Ollama::Handlers::Markdown do
 
   it 'can markdown message content as markdown' do
     output = double('output', :sync= => true)
-    expect(output).to receive(:print).with("\e[2J", "\e[1;1H", ansi)
+    expect(output).to receive(:print).with("\e[1;1H", "\e[J", ansi)
     markdown = described_class.new(output:)
     response = double('response', response: nil, message: double(content: md), done: false)
     markdown.call(response)

data/spec/ollama/options_spec.rb

@@ -53,4 +53,58 @@ describe Ollama::Options do
     expect { described_class.new(penalize_newline: :tertium) }.
       to raise_error(TypeError)
   end
+
+  context '.from_string' do
+    it 'parses boolean values' do
+      result = described_class.from_string("use_mmap true\nuse_mlock false")
+      expect(result.use_mmap).to be true
+      expect(result.use_mlock).to be false
+    end
+
+    it 'parses integer values' do
+      result = described_class.from_string("num_ctx 8192\nnum_batch 512")
+      expect(result.num_ctx).to eq(8192)
+      expect(result.num_batch).to eq(512)
+    end
+
+    it 'parses negative integers' do
+      result = described_class.from_string("num_predict -1")
+      expect(result.num_predict).to eq(-1)
+    end
+
+    it 'parses float values' do
+      result = described_class.from_string("temperature 0.7\ntop_p 0.95")
+      expect(result.temperature).to be_within(1e-6).of(0.7)
+      expect(result.top_p).to be_within(1e-6).of(0.95)
+    end
+
+    it 'accumulates array values for multi-line keys' do
+      result = described_class.from_string(<<~EOS)
+        stop <|start_header_id|>
+        stop <|end_header_id|>
+        stop <|eot_id|>
+      EOS
+      expect(result.stop).to eq(
+        ['<|start_header_id|>', '<|end_header_id|>', '<|eot_id|>']
+      )
+    end
+
+    it 'handles mixed types in a single block' do
+      result = described_class.from_string(<<~EOS)
+        use_mmap true
+        num_ctx 4096
+        temperature 0.8
+        stop end
+      EOS
+      expect(result.use_mmap).to be true
+      expect(result.num_ctx).to eq(4096)
+      expect(result.temperature).to be_within(1e-6).of(0.8)
+      expect(result.stop).to eq(['end'])
+    end
+
+    it 'skips unparseable lines gracefully' do
+      result = described_class.from_string("temperature 0.7\ngarbage hello")
+      expect(result.temperature).to be_within(1e-6).of(0.7)
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ollama-ruby
 version: !ruby/object:Gem::Version
-  version: 1.23.1
+  version: 1.24.0
 platform: ruby
 authors:
 - Florian Frank
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.17.1
+        version: 2.18.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.17.1
+        version: 2.18.0
 - !ruby/object:Gem::Dependency
   name: all_images
   requirement: !ruby/object:Gem::Requirement
@@ -424,7 +424,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.17
+rubygems_version: 4.0.22
 specification_version: 4
 summary: Interacting with the Ollama API
 test_files: