Class: Cohere::Transcribe::TranscriptionOptions

Inherits:
Data
  • Object
show all
Defined in:
lib/cohere/transcribe/types.rb,
sig/cohere/transcribe.rbs

Overview

Complete transcription configuration shared with the command-line interface.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(model: TypesSupport::DEFAULT_ASR_MODEL_ID, model_revision: nil, adapter: nil, adapter_revision: nil, language: "ar", text_only: false, recursive: true, device: "auto", dtype: "auto", audio_backend: "auto", audio_memory_gb: 4.0, preprocess_workers: nil, pipeline_preparation: true, vad: "silero", vad_engine: "auto", vad_batch_size: 16, vad_block_frames: 512, vad_threads: nil, vad_merge: false, min_dur: 0.5, max_dur: 30.0, max_silence: 0.6, energy_threshold: 50.0, vad_threshold: 0.5, min_silence_ms: 300, speech_pad_ms: 60, batch_size: nil, batch_max_size: nil, batch_audio_seconds: nil, batch_vram_target: 0.9, adaptive_batch: false, pin_memory: false, max_new_tokens: 445, max_retry_tokens: 896, truncation_policy: "retry", stop_repetition_loops: true, alignment: "segment", align_batch_size: 4, align_dtype: "fp32", max_chars: 80, max_cue_dur: 6.0, max_gap: 0.6, publication: nil) ⇒ TranscriptionOptions

Returns a new instance of TranscriptionOptions.



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/cohere/transcribe/types.rb', line 154

def initialize(
  model: TypesSupport::DEFAULT_ASR_MODEL_ID,
  model_revision: nil,
  adapter: nil,
  adapter_revision: nil,
  language: "ar",
  text_only: false,
  recursive: true,
  device: "auto",
  dtype: "auto",
  audio_backend: "auto",
  audio_memory_gb: 4.0,
  preprocess_workers: nil,
  pipeline_preparation: true,
  vad: "silero",
  vad_engine: "auto",
  vad_batch_size: 16,
  vad_block_frames: 512,
  vad_threads: nil,
  vad_merge: false,
  min_dur: 0.5,
  max_dur: 30.0,
  max_silence: 0.6,
  energy_threshold: 50.0,
  vad_threshold: 0.5,
  min_silence_ms: 300,
  speech_pad_ms: 60,
  batch_size: nil,
  batch_max_size: nil,
  batch_audio_seconds: nil,
  batch_vram_target: 0.9,
  adaptive_batch: false,
  pin_memory: false,
  max_new_tokens: 445,
  max_retry_tokens: 896,
  truncation_policy: "retry",
  stop_repetition_loops: true,
  alignment: "segment",
  align_batch_size: 4,
  align_dtype: "fp32",
  max_chars: 80,
  max_cue_dur: 6.0,
  max_gap: 0.6,
  publication: nil
)
  super(
    model: TypesSupport.reference(model),
    model_revision: TypesSupport.reference(model_revision),
    adapter: TypesSupport.reference(adapter),
    adapter_revision: TypesSupport.reference(adapter_revision),
    language: TypesSupport.immutable(language),
    text_only: text_only,
    recursive: recursive,
    device: TypesSupport.immutable(device),
    dtype: TypesSupport.immutable(dtype),
    audio_backend: TypesSupport.immutable(audio_backend),
    audio_memory_gb: audio_memory_gb,
    preprocess_workers: preprocess_workers,
    pipeline_preparation: pipeline_preparation,
    vad: TypesSupport.immutable(vad),
    vad_engine: TypesSupport.immutable(vad_engine),
    vad_batch_size: vad_batch_size,
    vad_block_frames: vad_block_frames,
    vad_threads: vad_threads,
    vad_merge: vad_merge,
    min_dur: min_dur,
    max_dur: max_dur,
    max_silence: max_silence,
    energy_threshold: energy_threshold,
    vad_threshold: vad_threshold,
    min_silence_ms: min_silence_ms,
    speech_pad_ms: speech_pad_ms,
    batch_size: batch_size,
    batch_max_size: batch_max_size,
    batch_audio_seconds: batch_audio_seconds,
    batch_vram_target: batch_vram_target,
    adaptive_batch: adaptive_batch,
    pin_memory: pin_memory,
    max_new_tokens: max_new_tokens,
    max_retry_tokens: max_retry_tokens,
    truncation_policy: TypesSupport.immutable(truncation_policy),
    stop_repetition_loops: stop_repetition_loops,
    alignment: TypesSupport.immutable(alignment),
    align_batch_size: align_batch_size,
    align_dtype: TypesSupport.immutable(align_dtype),
    max_chars: max_chars,
    max_cue_dur: max_cue_dur,
    max_gap: max_gap,
    publication: publication
  )
end

Instance Attribute Details

#adapter ⇒ Object (readonly)

Returns the value of attribute adapter

Returns:

  • (Object) —

    the current value of adapter



109
110
111
 
# File 'lib/cohere/transcribe/types.rb', line 109

def adapter
  @adapter
end

#adapter_revision ⇒ Object (readonly)

Returns the value of attribute adapter_revision

Returns:

  • (Object) —

    the current value of adapter_revision



109
110
111
 
# File 'lib/cohere/transcribe/types.rb', line 109

def adapter_revision
  @adapter_revision
end

#adaptive_batch ⇒ Object (readonly)

Returns the value of attribute adaptive_batch

Returns:

  • (Object) —

    the current value of adaptive_batch



109
110
111
 
# File 'lib/cohere/transcribe/types.rb', line 109

def adaptive_batch
  @adaptive_batch
end

#align_batch_size ⇒ Object (readonly)

Returns the value of attribute align_batch_size

Returns:

  • (Object) —

    the current value of align_batch_size



109
110
111
 
# File 'lib/cohere/transcribe/types.rb', line 109

def align_batch_size
  @align_batch_size
end

#align_dtype ⇒ Object (readonly)

Returns the value of attribute align_dtype

Returns:

  • (Object) —

    the current value of align_dtype



109
110
111
 
# File 'lib/cohere/transcribe/types.rb', line 109

def align_dtype
  @align_dtype
end

#alignment ⇒ Object (readonly)

Returns the value of attribute alignment

Returns:

  • (Object) —

    the current value of alignment



109
110
111
 
# File 'lib/cohere/transcribe/types.rb', line 109

def alignment
  @alignment
end

#audio_backend ⇒ Object (readonly)

Returns the value of attribute audio_backend

Returns:

  • (Object) —

    the current value of audio_backend



109
110
111
 
# File 'lib/cohere/transcribe/types.rb', line 109

def audio_backend
  @audio_backend
end

#audio_memory_gb ⇒ Object (readonly)

Returns the value of attribute audio_memory_gb

Returns:

  • (Object) —

    the current value of audio_memory_gb



109
110
111
 
# File 'lib/cohere/transcribe/types.rb', line 109

def audio_memory_gb
  @audio_memory_gb
end

#batch_audio_seconds ⇒ Object (readonly)

Returns the value of attribute batch_audio_seconds

Returns:

  • (Object) —

    the current value of batch_audio_seconds



109
110
111
 
# File 'lib/cohere/transcribe/types.rb', line 109

def batch_audio_seconds
  @batch_audio_seconds
end

#batch_max_size ⇒ Object (readonly)

Returns the value of attribute batch_max_size

Returns:

  • (Object) —

    the current value of batch_max_size



109
110
111
 
# File 'lib/cohere/transcribe/types.rb', line 109

def batch_max_size
  @batch_max_size
end

#batch_size ⇒ Object (readonly)

Returns the value of attribute batch_size

Returns:

  • (Object) —

    the current value of batch_size



109
110
111
 
# File 'lib/cohere/transcribe/types.rb', line 109

def batch_size
  @batch_size
end

#batch_vram_target ⇒ Object (readonly)

Returns the value of attribute batch_vram_target

Returns:

  • (Object) —

    the current value of batch_vram_target



109
110
111
 
# File 'lib/cohere/transcribe/types.rb', line 109

def batch_vram_target
  @batch_vram_target
end

#device ⇒ Object (readonly)

Returns the value of attribute device

Returns:

  • (Object) —

    the current value of device



109
110
111
 
# File 'lib/cohere/transcribe/types.rb', line 109

def device
  @device
end

#dtype ⇒ Object (readonly)

Returns the value of attribute dtype

Returns:

  • (Object) —

    the current value of dtype



109
110
111
 
# File 'lib/cohere/transcribe/types.rb', line 109

def dtype
  @dtype
end

#energy_threshold ⇒ Object (readonly)

Returns the value of attribute energy_threshold

Returns:

  • (Object) —

    the current value of energy_threshold



109
110
111
 
# File 'lib/cohere/transcribe/types.rb', line 109

def energy_threshold
  @energy_threshold
end

#language ⇒ Object (readonly)

Returns the value of attribute language

Returns:

  • (Object) —

    the current value of language



109
110
111
 
# File 'lib/cohere/transcribe/types.rb', line 109

def language
  @language
end

#max_chars ⇒ Object (readonly)

Returns the value of attribute max_chars

Returns:

  • (Object) —

    the current value of max_chars



109
110
111
 
# File 'lib/cohere/transcribe/types.rb', line 109

def max_chars
  @max_chars
end

#max_cue_dur ⇒ Object (readonly)

Returns the value of attribute max_cue_dur

Returns:

  • (Object) —

    the current value of max_cue_dur



109
110
111
 
# File 'lib/cohere/transcribe/types.rb', line 109

def max_cue_dur
  @max_cue_dur
end

#max_dur ⇒ Object (readonly)

Returns the value of attribute max_dur

Returns:

  • (Object) —

    the current value of max_dur



109
110
111
 
# File 'lib/cohere/transcribe/types.rb', line 109

def max_dur
  @max_dur
end

#max_gap ⇒ Object (readonly)

Returns the value of attribute max_gap

Returns:

  • (Object) —

    the current value of max_gap



109
110
111
 
# File 'lib/cohere/transcribe/types.rb', line 109

def max_gap
  @max_gap
end

#max_new_tokens ⇒ Object (readonly)

Returns the value of attribute max_new_tokens

Returns:

  • (Object) —

    the current value of max_new_tokens



109
110
111
 
# File 'lib/cohere/transcribe/types.rb', line 109

def max_new_tokens
  @max_new_tokens
end

#max_retry_tokens ⇒ Object (readonly)

Returns the value of attribute max_retry_tokens

Returns:

  • (Object) —

    the current value of max_retry_tokens



109
110
111
 
# File 'lib/cohere/transcribe/types.rb', line 109

def max_retry_tokens
  @max_retry_tokens
end

#max_silence ⇒ Object (readonly)

Returns the value of attribute max_silence

Returns:

  • (Object) —

    the current value of max_silence



109
110
111
 
# File 'lib/cohere/transcribe/types.rb', line 109

def max_silence
  @max_silence
end

#min_dur ⇒ Object (readonly)

Returns the value of attribute min_dur

Returns:

  • (Object) —

    the current value of min_dur



109
110
111
 
# File 'lib/cohere/transcribe/types.rb', line 109

def min_dur
  @min_dur
end

#min_silence_ms ⇒ Object (readonly)

Returns the value of attribute min_silence_ms

Returns:

  • (Object) —

    the current value of min_silence_ms



109
110
111
 
# File 'lib/cohere/transcribe/types.rb', line 109

def min_silence_ms
  @min_silence_ms
end

#model ⇒ Object (readonly)

Returns the value of attribute model

Returns:

  • (Object) —

    the current value of model



109
110
111
 
# File 'lib/cohere/transcribe/types.rb', line 109

def model
  @model
end

#model_revision ⇒ Object (readonly)

Returns the value of attribute model_revision

Returns:

  • (Object) —

    the current value of model_revision



109
110
111
 
# File 'lib/cohere/transcribe/types.rb', line 109

def model_revision
  @model_revision
end

#pin_memory ⇒ Object (readonly)

Returns the value of attribute pin_memory

Returns:

  • (Object) —

    the current value of pin_memory



109
110
111
 
# File 'lib/cohere/transcribe/types.rb', line 109

def pin_memory
  @pin_memory
end

#pipeline_preparation ⇒ Object (readonly)

Returns the value of attribute pipeline_preparation

Returns:

  • (Object) —

    the current value of pipeline_preparation



109
110
111
 
# File 'lib/cohere/transcribe/types.rb', line 109

def pipeline_preparation
  @pipeline_preparation
end

#preprocess_workers ⇒ Object (readonly)

Returns the value of attribute preprocess_workers

Returns:

  • (Object) —

    the current value of preprocess_workers



109
110
111
 
# File 'lib/cohere/transcribe/types.rb', line 109

def preprocess_workers
  @preprocess_workers
end

#publication ⇒ Object (readonly)

Returns the value of attribute publication

Returns:

  • (Object) —

    the current value of publication



109
110
111
 
# File 'lib/cohere/transcribe/types.rb', line 109

def publication
  @publication
end

#recursive ⇒ Object (readonly)

Returns the value of attribute recursive

Returns:

  • (Object) —

    the current value of recursive



109
110
111
 
# File 'lib/cohere/transcribe/types.rb', line 109

def recursive
  @recursive
end

#speech_pad_ms ⇒ Object (readonly)

Returns the value of attribute speech_pad_ms

Returns:

  • (Object) —

    the current value of speech_pad_ms



109
110
111
 
# File 'lib/cohere/transcribe/types.rb', line 109

def speech_pad_ms
  @speech_pad_ms
end

#stop_repetition_loops ⇒ Object (readonly)

Returns the value of attribute stop_repetition_loops

Returns:

  • (Object) —

    the current value of stop_repetition_loops



109
110
111
 
# File 'lib/cohere/transcribe/types.rb', line 109

def stop_repetition_loops
  @stop_repetition_loops
end

#text_only ⇒ Object (readonly)

Returns the value of attribute text_only

Returns:

  • (Object) —

    the current value of text_only



109
110
111
 
# File 'lib/cohere/transcribe/types.rb', line 109

def text_only
  @text_only
end

#truncation_policy ⇒ Object (readonly)

Returns the value of attribute truncation_policy

Returns:

  • (Object) —

    the current value of truncation_policy



109
110
111
 
# File 'lib/cohere/transcribe/types.rb', line 109

def truncation_policy
  @truncation_policy
end

#vad ⇒ Object (readonly)

Returns the value of attribute vad

Returns:

  • (Object) —

    the current value of vad



109
110
111
 
# File 'lib/cohere/transcribe/types.rb', line 109

def vad
  @vad
end

#vad_batch_size ⇒ Object (readonly)

Returns the value of attribute vad_batch_size

Returns:

  • (Object) —

    the current value of vad_batch_size



109
110
111
 
# File 'lib/cohere/transcribe/types.rb', line 109

def vad_batch_size
  @vad_batch_size
end

#vad_block_frames ⇒ Object (readonly)

Returns the value of attribute vad_block_frames

Returns:

  • (Object) —

    the current value of vad_block_frames



109
110
111
 
# File 'lib/cohere/transcribe/types.rb', line 109

def vad_block_frames
  @vad_block_frames
end

#vad_engine ⇒ Object (readonly)

Returns the value of attribute vad_engine

Returns:

  • (Object) —

    the current value of vad_engine



109
110
111
 
# File 'lib/cohere/transcribe/types.rb', line 109

def vad_engine
  @vad_engine
end

#vad_merge ⇒ Object (readonly)

Returns the value of attribute vad_merge

Returns:

  • (Object) —

    the current value of vad_merge



109
110
111
 
# File 'lib/cohere/transcribe/types.rb', line 109

def vad_merge
  @vad_merge
end

#vad_threads ⇒ Object (readonly)

Returns the value of attribute vad_threads

Returns:

  • (Object) —

    the current value of vad_threads



109
110
111
 
# File 'lib/cohere/transcribe/types.rb', line 109

def vad_threads
  @vad_threads
end

#vad_threshold ⇒ Object (readonly)

Returns the value of attribute vad_threshold

Returns:

  • (Object) —

    the current value of vad_threshold



109
110
111
 
# File 'lib/cohere/transcribe/types.rb', line 109

def vad_threshold
  @vad_threshold
end

Class Method Details

.new ⇒ Object 



76
 
# File 'sig/cohere/transcribe.rbs', line 76

def self.new: (?model: path_input, ?model_revision: String?, ?adapter: path_input?,