Struct QkvParamsBase

pub struct QkvParamsBase<S, D = Ix2>
where
    D: Dimension,
    S: RawData,
{ /* private fields */ }

This object is designed to store the parameters of the QKV (Query, Key, Value)

Implementations

impl<A, S, D> QkvParamsBase<S, D>

where D: Dimension, S: RawData<Elem = A>,

pub fn new( query: ArrayBase<S, D>, key: ArrayBase<S, D>, value: ArrayBase<S, D>, ) -> Self

pub fn from_elem<Sh: ShapeBuilder<Dim = D>>(shape: Sh, elem: A) -> Self

where A: Clone, S: DataOwned,

pub fn default<Sh: ShapeBuilder<Dim = D>>(shape: Sh) -> Self

where A: Clone + Default, S: DataOwned,

pub fn ones<Sh: ShapeBuilder<Dim = D>>(shape: Sh) -> Self

where A: Clone + One, S: DataOwned,

pub fn zeros<Sh: ShapeBuilder<Dim = D>>(shape: Sh) -> Self

where A: Clone + Zero, S: DataOwned,

pub const fn key(&self) -> &ArrayBase<S, D>

returns an immutable reference to the key parameters

pub fn key_mut(&mut self) -> &mut ArrayBase<S, D>

returns a mutable reference to the key parameters

pub const fn query(&self) -> &ArrayBase<S, D>

returns an immutable reference to the query parameters

pub fn query_mut(&mut self) -> &mut ArrayBase<S, D>

returns a mutable reference to the query parameters

pub const fn value(&self) -> &ArrayBase<S, D>

returns an immutable reference to the value parameters

pub fn value_mut(&mut self) -> &mut ArrayBase<S, D>

returns a mutable reference to the value parameters

pub fn set_key(&mut self, key: ArrayBase<S, D>) -> &mut Self

pub fn set_query(&mut self, query: ArrayBase<S, D>) -> &mut Self

pub fn set_value(&mut self, value: ArrayBase<S, D>) -> &mut Self

pub fn with_key(self, key: ArrayBase<S, D>) -> Self

pub fn with_query(self, query: ArrayBase<S, D>) -> Self

pub fn with_value(self, value: ArrayBase<S, D>) -> Self

Trait Implementations

impl<X, Z, A, S, D> Forward<X> for QkvParamsBase<S, D>

where A: Clone, D: Dimension, S: Data<Elem = A>, X: Dot<ArrayBase<S, D>, Output = Z>, for<'a> Z: Add<Output = Z> + Add<&'a Z, Output = Z>,

This trait is used to implement the forward pass for the QKV parameters.

type Output = Z

fn forward(&self, input: &X) -> Result<Self::Output>

a single forward step

fn forward_then<F>(&self, input: &Rhs, then: F) -> Result<Self::Output, Error>

where F: FnOnce(Self::Output) -> Self::Output,

this method enables the forward pass to be generically activated using some closure. This is useful for isolating the logic of the forward pass from that of the activation function and is often used by layers and models.