Struct ClipModel 

pub struct ClipModel { /* private fields */ }

Represents a CLIP model loaded from a GGUF file.

Example

let model = cliprs::ClipModel::new("path/to/model.gguf");

let text_embedding = model.embed_text("A sample text").unwrap();

let image_embedding = model.embed_image("path/to/image.png").unwrap();

let similarity = model.embed_compare(&text_embedding, &image_embedding);

println!("Similarity: {}", similarity);

Implementations

impl ClipModel

pub fn new(model_path: impl Into<String>) -> Self

Initializes ClipModel with a model path.

Example

let model = cliprs::ClipModel::new("path/to/model.gguf");

pub fn embed_compare(&self, p1: &Vec<f32>, p2: &Vec<f32>) -> f32

Compares two embeddings and returns the similarity.

Example

let similarity = model.embed_compare(&text_embedding, &image_embedding);

pub fn embed_text(&self, text: impl Into<String>) -> Result<Vec<f32>, String>

Creates an embedding for a string

Example

let text_embedding = model.embed_text("blue car");

pub fn embed_image(&self, path: impl Into<String>) -> Result<Vec<f32>, String>

Creates an image embedding from a path

Example

let image_embedding = model.embed_image("path/to/image.jpg")

Trait Implementations

impl Drop for ClipModel

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl Send for ClipModel

impl Sync for ClipModel