Skip to main content

BitLinear

Struct BitLinear 

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

BitLinear layer with ternary weights and INT8 activations.

This is a drop-in replacement for candle_nn::Linear that uses:

  • Ternary weights {-1, 0, +1} with per-group scales
  • INT8 activation quantization with per-token scales

§Example

use bitnet_rs::{BitLinear, BitNetConfig};
use candle_core::{Device, Tensor};

let device = Device::Cpu;
let config = BitNetConfig::default();

// Create from existing weights
let weight = Tensor::randn(0.0f32, 1.0, (512, 256), &device)?;
let layer = BitLinear::from_weight(&weight, None, &config)?;

// Forward pass
let input = Tensor::randn(0.0f32, 1.0, (4, 256), &device)?;
let output = layer.forward(&input)?;

Implementations§

Source§

impl BitLinear

Source

pub fn from_weight( weight: &Tensor, bias: Option<&Tensor>, config: &BitNetConfig, ) -> Result<Self>

Create a new BitLinear layer from a weight tensor.

§Arguments
  • weight - Weight tensor [out_features, in_features]
  • bias - Optional bias tensor [out_features]
  • config - BitNet configuration
§Errors

Returns error if weight quantization fails.

Source

pub fn from_quantized( weight: TernaryWeight, bias: Option<Tensor>, config: BitNetConfig, device: Device, ) -> Self

Create a new BitLinear layer from pre-quantized weights.

§Arguments
  • weight - Pre-quantized ternary weight
  • bias - Optional bias tensor
  • config - BitNet configuration
  • device - Device for operations
Source

pub fn in_features(&self) -> usize

Get the input features dimension.

Source

pub fn out_features(&self) -> usize

Get the output features dimension.

Source

pub const fn quantized_weight(&self) -> &TernaryWeight

Get reference to the quantized weights.

Source

pub const fn bias(&self) -> Option<&Tensor>

Get reference to the bias.

Source

pub const fn config(&self) -> &BitNetConfig

Get reference to the configuration.

Source

pub const fn device(&self) -> &Device

Get the device.

Source

pub fn sparsity(&self) -> f32

Get the weight sparsity.

Source

pub fn compression_ratio(&self) -> f32

Get the compression ratio.

Source

pub fn forward_quantized(&self, input: &Tensor) -> Result<Tensor>

Forward pass with explicit activation quantization.

This method:

  1. Quantizes input activations to INT8
  2. Dequantizes weights for matmul (or uses optimized kernel)
  3. Performs the linear transformation
  4. Adds bias if present
§Arguments
  • input - Input tensor [batch, …, in_features]
§Errors

Returns error if forward pass fails.

Trait Implementations§

Source§

impl Debug for BitLinear

Source§

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

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

impl Module for BitLinear

Source§

fn forward(&self, input: &Tensor) -> Result<Tensor>

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.

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> 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<M> ModuleT for M
where M: Module,

Source§

fn forward_t(&self, xs: &Tensor, _train: bool) -> Result<Tensor, Error>

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