Skip to main content

BertConfig

Struct BertConfig 

Source
pub struct BertConfig {
    pub hidden_dim: usize,
    pub num_layers: usize,
    pub num_heads: usize,
    pub intermediate_dim: usize,
    pub vocab_size: usize,
    pub max_position_embeddings: usize,
    pub type_vocab_size: usize,
    pub layer_norm_eps: f32,
    pub pad_token_id: u32,
}
Expand description

BERT model configuration.

Maps to the relevant fields of HuggingFace BertConfig.

Fields§

§hidden_dim: usize

Hidden dimension of each token (e.g. 768 for base, 384 for MiniLM-L-6).

§num_layers: usize

Number of encoder layers (e.g. 12 for base, 6 for MiniLM-L-6).

§num_heads: usize

Number of attention heads. hidden_dim must divide evenly by this.

§intermediate_dim: usize

FFN intermediate dimension (typically 4 × hidden_dim).

§vocab_size: usize

Token vocabulary size (e.g. 30522 for bert-base-uncased).

§max_position_embeddings: usize

Maximum sequence length supported by position embeddings.

§type_vocab_size: usize

Token-type vocabulary size (typically 2 for [A] / [B] segments).

§layer_norm_eps: f32

LayerNorm epsilon (HuggingFace default 1e-12).

§pad_token_id: u32

Pad token id (typically 0). Used for attention masking.

Implementations§

Source§

impl BertConfig

Source

pub const fn head_dim(&self) -> usize

Compute the per-head dimension. hidden_dim must be divisible by num_heads.

Source

pub fn minilm_l6() -> BertConfig

MiniLM-L-6 preset (22M params, 384 hidden, 12 heads, 6 layers).

Source

pub fn validate(&self) -> Result<(), BertConfigError>

Check the structural invariants that model construction asserts.

MultiHeadAttention::new (reached via BertEncoder::new / CrossEncoder::new) asserts that hidden_dim is a multiple of num_heads, and head_dim() divides by num_heads. Callers that build a config from untrusted input (CLI overrides, config files) must call this first and surface the error, instead of letting the assert abort the process.

§Errors

Returns BertConfigError naming the offending field when hidden_dim or num_heads is zero, or when hidden_dim is not divisible by num_heads.

Source

pub fn validate_ids( &self, input_ids: &[u32], token_type_ids: &[u32], ) -> Result<(), BertConfigError>

Check a token-id batch against this config before a forward pass.

BertEmbeddings::forward indexes the word/position/token-type tables with the raw ids and slices them unchecked, so an id at or above the corresponding table size aborts the process with a slice-range panic. This is the fallible pre-check for any caller feeding user-supplied ids.

§Errors

Returns BertConfigError for a length mismatch, a sequence longer than max_position_embeddings, an input id >= vocab_size, or a token-type id >= type_vocab_size.

Trait Implementations§

Source§

impl Clone for BertConfig

Source§

fn clone(&self) -> BertConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for BertConfig

Source§

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

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

impl Default for BertConfig

Source§

fn default() -> BertConfig

bert-base-uncased defaults.

Source§

impl PartialEq for BertConfig

Source§

fn eq(&self, other: &BertConfig) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for BertConfig

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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

Source§

fn downcast(&self) -> &T

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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 = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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

Source§

fn upcast(&self) -> Option<&T>

Source§

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

Source§

fn vzip(self) -> V

Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,