Update type signatures

Author: KitaitiMakoto

bindings/ruby/sig/whisper.rbs

@@ -24,7 +24,7 @@ module Whisper
   def self.finalize_log_callback: (void) -> void # Second argument of ObjectSpace.define_finalizer
 
   class Context
-    def initialize: (string | _ToPath | ::URI::HTTP ) -> void
+    def initialize: (string | _ToPath | ::URI::HTTP) -> void
     def transcribe: (string, Params) -> void
                   | (string, Params) { (String) -> void } -> void
     def model_n_vocab: () -> Integer
@@ -42,18 +42,49 @@ module Whisper
     def full_get_segment_speaker_turn_next: (Integer) -> (true | false)
     def full_get_segment_text: (Integer) -> String
     def full_get_segment_no_speech_prob: (Integer) -> Float
-    def full: (Params, Array[Float], ?Integer) -> void
-            | (Params, _Samples, ?Integer) -> void
-    def full_parallel: (Params, Array[Float], ?Integer) -> void
-                     | (Params, _Samples, ?Integer) -> void
-                     | (Params, _Samples, ?Integer?, Integer) -> void
+    def full: (Params, Array[Float] samples, ?Integer n_samples) -> void
+            | (Params, _Samples, ?Integer n_samples) -> void
+    def full_parallel: (Params, Array[Float], ?Integer n_samples) -> void
+                     | (Params, _Samples, ?Integer n_samples) -> void
+                     | (Params, _Samples, ?Integer? n_samples, Integer n_processors) -> void
     def each_segment: { (Segment) -> void } -> void
                     | () -> Enumerator[Segment]
     def model: () -> Model
   end
 
   class Params
-    def initialize: () -> void
+    def initialize: (
+      ?language: string,
+      ?translate: boolish,
+      ?no_context: boolish,
+      ?single_segment: boolish,
+      ?print_special: boolish,
+      ?print_progress: boolish,
+      ?print_realtime: boolish,
+      ?print_timestamps: boolish,
+      ?suppress_blank: boolish,
+      ?suppress_nst: boolish,
+      ?token_timestamps: boolish,
+      ?split_on_word: boolish,
+      ?initial_prompt: string | nil,
+      ?diarize: boolish,
+      ?offset: Integer,
+      ?duration: Integer,
+      ?max_text_tokens: Integer,
+      ?temperature: Float,
+      ?max_initial_ts: Float,
+      ?length_penalty: Float,
+      ?temperature_inc: Float,
+      ?entropy_thold: Float,
+      ?logprob_thold: Float,
+      ?no_speech_thold: Float,
+      ?new_segment_callback: new_segment_callback,
+      ?new_segment_callback_user_data: Object,
+      ?progress_callback: progress_callback,
+      ?progress_callback_user_data: Object,
+      ?abort_callback: abort_callback,
+      ?abort_callback_user_data: Object
+    ) -> void
     def language=: (String) -> String # TODO: Enumerate lang names
     def language: () -> String
     def translate=: (boolish) -> boolish
@@ -79,7 +110,7 @@ module Whisper
     def split_on_word=: (boolish) -> boolish
     def split_on_word: () -> (true | false)
     def initial_prompt=: (_ToS) -> _ToS
-    def initial_prompt: () -> String
+    def initial_prompt: () -> (String | nil)
     def diarize=: (boolish) -> boolish
     def diarize: () -> (true | false)
     def offset=: (Integer) -> Integer
@@ -103,14 +134,20 @@ module Whisper
     def no_speech_thold=: (Float) -> Float
     def no_speech_thold: () -> Float
     def new_segment_callback=: (new_segment_callback) -> new_segment_callback
+    def new_segment_callback: () -> (new_segment_callback | nil)
     def new_segment_callback_user_data=: (Object) -> Object
+    def new_segment_callback_user_data: () -> Object
     def progress_callback=: (progress_callback) -> progress_callback
+    def progress_callback: () -> (progress_callback | nil)
     def progress_callback_user_data=: (Object) -> Object
+    def progress_callback_user_data: () -> Object
     def abort_callback=: (abort_callback) -> abort_callback
+    def abort_callback: () -> (abort_callback | nil)
     def abort_callback_user_data=: (Object) -> Object
+    def abort_callback_user_data: () -> Object
     def on_new_segment: { (Segment) -> void } -> void
-    def on_progress: { (Integer) -> void } -> void
-    def abort_on: { (Object) -> boolish } -> void
+    def on_progress: { (Integer progress) -> void } -> void
+    def abort_on: { (Object user_data) -> boolish } -> void
   end
 
   class Model
@@ -148,6 +185,6 @@ module Whisper
   class Error < StandardError
     attr_reader code: Integer
 
-    def initialize: (Integer) -> void
+    def initialize: (Integer code) -> void
   end
 end

bindings/ruby/tests/test_params.rb

@@ -1,38 +1,38 @@
 require_relative "helper"
 
 class TestParams < TestBase
-  DEFAULT_VALUES = {
-    language: "en",
-    translate: false,
-    no_context: true,
-    single_segment: false,
-    print_special: false,
-    print_progress: true,
-    print_realtime: false,
-    print_timestamps: true,
-    suppress_blank: true,
-    suppress_nst: false,
-    token_timestamps: false,
-    split_on_word: false,
-    initial_prompt: nil,
-    diarize: false,
-    offset: 0,
-    duration: 0,
-    max_text_tokens: 16384,
-    temperature: 0.0,
-    max_initial_ts: 1.0,
-    length_penalty: -1.0,
-    temperature_inc: 0.2,
-    entropy_thold: 2.4,
-    logprob_thold: -1.0,
-    no_speech_thold: 0.6,
-    new_segment_callback: nil,
-    new_segment_callback_user_data: nil,
-    progress_callback: nil,
-    progress_callback_user_data: nil,
-    abort_callback: nil,
-    abort_callback_user_data: nil
-  }
+  PARAM_NAMES = [
+    :language,
+    :translate,
+    :no_context,
+    :single_segment,
+    :print_special,
+    :print_progress,
+    :print_realtime,
+    :print_timestamps,
+    :suppress_blank,
+    :suppress_nst,
+    :token_timestamps,
+    :split_on_word,
+    :initial_prompt,
+    :diarize,
+    :offset,
+    :duration,
+    :max_text_tokens,
+    :temperature,
+    :max_initial_ts,
+    :length_penalty,
+    :temperature_inc,
+    :entropy_thold,
+    :logprob_thold,
+    :no_speech_thold,
+    :new_segment_callback,
+    :new_segment_callback_user_data,
+    :progress_callback,
+    :progress_callback_user_data,
+    :abort_callback,
+    :abort_callback_user_data,
+  ]
 
   def setup
     @params  = Whisper::Params.new
@@ -209,9 +209,9 @@ def test_new_with_kw_args_wrong_type
     end
   end
 
-  data(DEFAULT_VALUES.collect {|param, value| [param, [param, value]]}.to_h)
-  def test_new_with_kw_args_default_values(data)
-    param, default_value = data
+  data(PARAM_NAMES.collect {|param| [param, param]}.to_h)
+  def test_new_with_kw_args_default_values(param)
+    default_value = @params.send(param)
     value = case [param, default_value]
             in [*, true | false]
               !default_value
@@ -233,11 +233,13 @@ def test_new_with_kw_args_default_values(data)
       assert_equal value, params.send(param)
     end
 
-    DEFAULT_VALUES.except(param).each do |key, default_value|
-      if Float === default_value
-        assert_in_delta default_value, params.send(key)
+    PARAM_NAMES.reject {|name| name == param}.each do |name|
+      expected = @params.send(name)
+      actual = params.send(name)
+      if Float === expected
+        assert_in_delta expected, actual
       else
-        assert_equal default_value, params.send(key)
+        assert_equal expected, actual
       end
     end
   end