pub struct SparseAdamTable { /* private fields */ }Expand description
Sparse / lazy Adam optimizer over a 2-D embedding table.
Mirrors SparseAdam but operates on an Array2 with a CsrGradient.
Moment state is stored flat, indexed by row * cols + col.
Implementations§
Source§impl SparseAdamTable
impl SparseAdamTable
Sourcepub fn new(config: SparseAdamConfig) -> Self
pub fn new(config: SparseAdamConfig) -> Self
Create a new table optimizer. State is allocated lazily on the first
SparseAdamTable::step.
Sourcepub fn global_step(&self) -> usize
pub fn global_step(&self) -> usize
The number of optimizer steps performed so far.
Sourcepub fn step(
&mut self,
params: &mut Array2<f64>,
grad: &CsrGradient,
) -> Result<(), GpuOptimError>
pub fn step( &mut self, params: &mut Array2<f64>, grad: &CsrGradient, ) -> Result<(), GpuOptimError>
Perform one sparse Adam update on the embedding table in place.
§Errors
Returns GpuOptimError::DimensionMismatch on any shape disagreement and
propagates gradient validation errors.
Trait Implementations§
Source§impl Clone for SparseAdamTable
impl Clone for SparseAdamTable
Source§fn clone(&self) -> SparseAdamTable
fn clone(&self) -> SparseAdamTable
Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreAuto Trait Implementations§
impl Freeze for SparseAdamTable
impl RefUnwindSafe for SparseAdamTable
impl Send for SparseAdamTable
impl Sync for SparseAdamTable
impl Unpin for SparseAdamTable
impl UnsafeUnpin for SparseAdamTable
impl UnwindSafe for SparseAdamTable
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
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