Config

Struct Config 

Source
pub struct Config { /* private fields */ }
Expand description

Configuration for a Model. See Model::from_pretrained for a simple way to get started.

Implementations§

Source§

impl Config

Source

pub fn transducer( encoder: &str, decoder: &str, joiner: &str, tokens: &str, ) -> Self

Make a new Config for a transducer model with reasonable defaults.

Source

pub fn paraformer(encoder: &str, decoder: &str, tokens: &str) -> Self

Make a new Config for a paraformer model with reasonable defaults.

Source

pub fn zipformer2_ctc(model: &str, tokens: &str) -> Self

Make a new Config for a zipformer2 ctc model with reasonable defaults.

Source

pub fn sample_rate(self, rate: usize) -> Self

Set the model’s sample rate - usually 16000 for most transducers.

Source

pub fn feature_dim(self, dim: usize) -> Self

Set the model’s feature dimension - usually 80 for most transducers.

Source

pub fn num_threads(self, n: usize) -> Self

Set the number of threads to use. Defaults to physical core count or 8, whichever is smaller.

Source

pub fn cpu(self) -> Self

Use CPU as the compute provider.

Source

pub fn cuda(self) -> Self

Available on crate feature cuda only.

Use CUDA as the compute provider. This requires CUDA 11.8.

Source

pub fn directml(self) -> Self

Available on crate feature directml only.

Use DirectML as the compute provider.

Source

pub fn debug(self, enable: bool) -> Self

Print debug messages at model load time.

Take the symbol with largest posterior probability of each frame as the decoding result.

Keep topk states for each frame, then expand kept states with their own contexts to next frame.

Source

pub fn max_active_paths(self, n: usize) -> Self

Maximum number of active paths to keep when Config::modified_beam_search is used.

Defaults to 16.

Source

pub fn detect_endpoints(self, enable: bool) -> Self

Enable endpoint detection. Defaults to disabled.

Source

pub fn rule1_min_trailing_silence(self, seconds: f32) -> Self

Detect endpoint if trailing silence is larger than this value even if nothing has been decoded.

Source

pub fn rule2_min_trailing_silence(self, seconds: f32) -> Self

Detect endpoint if trailing silence is larger than this value and a non-blank has been decoded.

Source

pub fn rule3_min_utterance_length(self, seconds: f32) -> Self

Detect an endpoint if an utterance is larger than this value.

Source

pub fn build(self) -> Result<Model>

Build your very own Model.

Trait Implementations§

Source§

impl Clone for Config

Source§

fn clone(&self) -> Config

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

Auto Trait Implementations§

§

impl Freeze for Config

§

impl RefUnwindSafe for Config

§

impl Send for Config

§

impl Sync for Config

§

impl Unpin for Config

§

impl UnwindSafe for Config

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> MaybeSendSync for T