CandleEmbedder

Struct CandleEmbedder 

Source
pub struct CandleEmbedder {
    device: Device,
    model: Arc<RwLock<Option<BertModel>>>,
    tokenizer: Arc<RwLock<Option<Tokenizer>>>,
    config: Arc<RwLock<Option<Config>>>,
    cache_dir: PathBuf,
    initialized: Arc<RwLock<bool>>,
}
Expand description

GTE-small embedder using Candle.

Fields§

§device: Device

Device to run inference on (CPU or CUDA)

§model: Arc<RwLock<Option<BertModel>>>

Loaded model

§tokenizer: Arc<RwLock<Option<Tokenizer>>>

Tokenizer

§config: Arc<RwLock<Option<Config>>>

Model configuration

§cache_dir: PathBuf

Cache directory for models

§initialized: Arc<RwLock<bool>>

Whether model is initialized

Implementations§

Source§

impl CandleEmbedder

Source

pub fn new(cache_dir: PathBuf) -> Self

Create a new CandleEmbedder.

Source

pub fn with_device(cache_dir: PathBuf, device: Device) -> Self

Create with specific device.

Source

pub async fn init(&self) -> Result<(), EmbedError>

Initialize the model (download if needed, load into memory).

Source

fn mean_pooling( &self, token_embeddings: &Tensor, attention_mask: &Tensor, ) -> Result<Tensor, EmbedError>

Mean pooling with attention mask.

Source

fn normalize(&self, embeddings: &Tensor) -> Result<Tensor, EmbedError>

L2 normalize embeddings.

Source

async fn encode_batch( &self, texts: &[&str], normalize: bool, ) -> Result<Vec<EmbeddingOutput>, EmbedError>

Encode a batch of texts.

Trait Implementations§

Source§

impl Embedder for CandleEmbedder

Source§

fn model_name(&self) -> &str

Model name/identifier.
Source§

fn dimension(&self) -> usize

Embedding dimension.
Source§

fn max_tokens(&self) -> usize

Maximum tokens per input.
Source§

fn modalities(&self) -> &[Modality]

Supported modalities.
Source§

fn embed_text<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, texts: &'life1 [&'life2 str], config: &'life3 EmbeddingConfig, ) -> Pin<Box<dyn Future<Output = Result<Vec<EmbeddingOutput>, EmbedError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Embed text content.
Source§

fn embed_query<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, query: &'life1 str, config: &'life2 EmbeddingConfig, ) -> Pin<Box<dyn Future<Output = Result<EmbeddingOutput, EmbedError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Embed a query (may use different instruction).
Source§

fn embed_image<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _image_data: &'life1 [u8], _config: &'life2 EmbeddingConfig, ) -> Pin<Box<dyn Future<Output = Result<EmbeddingOutput, EmbedError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, Self: 'async_trait,

Embed image content.

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

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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> 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
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

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

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. 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.
§

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

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

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