mlx_rs::nn

Struct QuantizedEmbeddingBuilder

Source
pub struct QuantizedEmbeddingBuilder {
    pub embedding_count: i32,
    pub dimensions: i32,
    pub group_size: i32,
    pub bits: i32,
}
Expand description

Builder for QuantizedEmbedding

Fields§

§embedding_count: i32

How many possible discrete tokens can we embed. Usually called the vocabulary size.

§dimensions: i32

The dimensionality of the embeddings.

§group_size: i32

Quantization group size. Default to QuantizedEmbedding::DEFAULT_GROUP_SIZE

§bits: i32

Bits per parameter. Default to QuantizedEmbedding::DEFAULT_BITS

Implementations§

Source§

impl QuantizedEmbeddingBuilder

Source

pub fn new(embedding_count: impl Into<i32>, dimensions: impl Into<i32>) -> Self

Source§

impl QuantizedEmbeddingBuilder

Source

pub fn group_size(self, group_size: impl Into<i32>) -> Self

Sets the value of [group_size].

Source

pub fn bits(self, bits: impl Into<i32>) -> Self

Sets the value of [bits].

Source§

impl QuantizedEmbeddingBuilder

Source

pub fn build_with_embedding( self, embedding: Embedding, ) -> Result<QuantizedEmbedding, Exception>

Convenience method to build a new QuantizedEmbedding with an existing Embedding

Source

pub fn build_with_weight( self, weight: Array, ) -> Result<QuantizedEmbedding, Exception>

Convenience method to build a new QuantizedEmbedding with an existing weight matrix

Trait Implementations§

Source§

impl Builder<QuantizedEmbedding> for QuantizedEmbeddingBuilder

Source§

type Error = Exception

Error with building
Source§

fn build(self) -> Result<QuantizedEmbedding, Self::Error>

Build the type
Source§

impl Clone for QuantizedEmbeddingBuilder

Source§

fn clone(&self) -> QuantizedEmbeddingBuilder

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

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

Performs copy-assignment from source. Read more
Source§

impl Debug for QuantizedEmbeddingBuilder

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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, dst: *mut u8)

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

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> IntoOption<T> for T

Source§

fn into_option(self) -> Option<T>

Convert into an Option.
Source§

impl<T> IntoStrideBy for T

Source§

fn stride_by(self, stride: i32) -> StrideBy<T>

Create a stride indexing operation.
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.