ClipEncoder

Struct ClipEncoder 

Source
pub struct ClipEncoder<B: Backend> { /* private fields */ }
Expand description

CLIP vision encoder for DeepSeek-OCR.

Implements the CLIP-Large architecture (or configurable variants) for global semantic understanding of visual features. Processes patch embeddings through a stack of transformer blocks with pre-LayerNorm and Quick GELU activation.

§Architecture Details

  • Input: RGB images [B, 3, H, W]
  • Patch embedding: Splits image into non-overlapping patches
  • Class token: Learnable token prepended to sequence
  • Position encoding: Added to all tokens
  • Transformer: Stack of attention + FFN blocks
  • Output: Sequence of embeddings [B, num_patches+1, hidden_size]

§Default Configuration (CLIP-Large)

  • 1024-dimensional embeddings
  • 24 transformer layers
  • 16 attention heads per layer
  • 4096-dimensional feed-forward hidden layer
  • 14×14 patch size on 224×224 images (256 patches)

§Example

let config = ClipConfig::large();
let encoder = ClipEncoder::new(&config, &device);

let image = Tensor::zeros(, &device);[1]
let features = encoder.forward(image, None);
// features shape:  (256 patches + 1 class token)[1]

Implementations§

Source§

impl<B: Backend> ClipEncoder<B>

Source

pub fn new(cfg: &ClipConfig, device: &B::Device) -> Self

Creates a new CLIP encoder.

Initializes all layers including embeddings, pre-LayerNorm, and transformer blocks according to the provided configuration.

§Arguments
  • cfg - CLIP configuration specifying model architecture
  • device - Device for tensor allocation (CPU/GPU)
§Returns

Fully initialized CLIP encoder ready for inference

Source

pub fn forward( &self, x: Tensor<B, 4>, _patch_embeds: Option<Tensor<B, 4>>, ) -> Tensor<B, 3>

Forward pass through CLIP encoder.

Processes input images through patch embedding, position encoding, and transformer layers to produce semantic visual features.

§Arguments
  • x - Input image tensor of shape [B, 3, H, W]
  • _patch_embeds - Optional pre-computed patch embeddings (currently unused, reserved for future integration with SAM features)
§Returns

Feature tensor of shape [B, num_patches+1, hidden_size] where the first token (index 0) is the class token and remaining tokens are patch features.

§Note

The _patch_embeds parameter is currently ignored. Full integration with SAM features would require a projection layer to match embedding dimensions.

Source

pub fn forward_features( &self, x: Tensor<B, 4>, patch_embeds: Option<Tensor<B, 4>>, ) -> Tensor<B, 3>

Forward pass excluding class token.

Convenience method that runs the encoder and strips the class token from the output sequence, returning only patch feature embeddings.

§Arguments
  • x - Input image tensor of shape [B, 3, H, W]
  • patch_embeds - Optional pre-computed patch embeddings
§Returns

Patch features of shape [B, num_patches, hidden_size] with the class token removed (excludes first token in sequence).

Trait Implementations§

Source§

impl<B> AutodiffModule<B> for ClipEncoder<B>

Source§

type InnerModule = ClipEncoder<<B as AutodiffBackend>::InnerBackend>

Inner module without auto-differentiation.
Source§

fn valid(&self) -> Self::InnerModule

Get the same module, but on the inner backend without auto-differentiation.
Source§

impl<B: Backend> Clone for ClipEncoder<B>

Source§

fn clone(&self) -> Self

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

impl<B: Debug + Backend> Debug for ClipEncoder<B>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<B: Backend> Display for ClipEncoder<B>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<B: Backend> Module<B> for ClipEncoder<B>

Source§

type Record = ClipEncoderRecord<B>

Type to save and load the module.
Source§

fn load_record(self, record: Self::Record) -> Self

Load the module state from a record.
Source§

fn into_record(self) -> Self::Record

Convert the module into a record containing the state.
Source§

fn num_params(&self) -> usize

Get the number of parameters the module has, including all of its sub-modules.
Source§

fn visit<Visitor: ModuleVisitor<B>>(&self, visitor: &mut Visitor)

Visit each tensor parameter in the module with a visitor.
Source§

fn map<Mapper: ModuleMapper<B>>(self, mapper: &mut Mapper) -> Self

Map each tensor parameter in the module with a mapper.
Source§

fn collect_devices(&self, devices: Devices<B>) -> Devices<B>

Return all the devices found in the underneath module tree added to the given vector without duplicates.
Source§

fn to_device(self, device: &B::Device) -> Self

Move the module and all of its sub-modules to the given device. Read more
Source§

fn fork(self, device: &B::Device) -> Self

Fork the module and all of its sub-modules to the given device. Read more
Source§

fn devices(&self) -> Vec<<B as Backend>::Device>

Return all the devices found in the underneath module tree without duplicates.
Source§

fn no_grad(self) -> Self

Each tensor in the module tree will not require grad. Read more
Source§

fn save_file<FR, PB>( self, file_path: PB, recorder: &FR, ) -> Result<(), RecorderError>
where FR: FileRecorder<B>, PB: Into<PathBuf>,

Save the module to a file using the provided file recorder. Read more
Source§

fn load_file<FR, PB>( self, file_path: PB, recorder: &FR, device: &<B as Backend>::Device, ) -> Result<Self, RecorderError>
where FR: FileRecorder<B>, PB: Into<PathBuf>,

Load the module from a file using the provided file recorder. Read more
Source§

fn quantize_weights(self, quantizer: &mut Quantizer) -> Self

Quantize the weights of the module.
Source§

impl<B: Backend> ModuleDisplay for ClipEncoder<B>

Source§

fn format(&self, passed_settings: DisplaySettings) -> String

Formats the module with provided display settings. Read more
Source§

fn custom_settings(&self) -> Option<DisplaySettings>

Custom display settings for the module. Read more
Source§

fn custom_content(&self, _content: Content) -> Option<Content>

Custom attributes for the module. Read more
Source§

impl<B: Backend> ModuleDisplayDefault for ClipEncoder<B>

Source§

fn content(&self, content: Content) -> Option<Content>

Attributes of the module used for display purposes. Read more
Source§

fn num_params(&self) -> usize

Gets the number of the parameters of the module.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Adaptor<()> for T

Source§

fn adapt(&self)

Adapt the type to be passed to a metric.
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, 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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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