Struct GradientValue 

pub struct GradientValue { /* private fields */ }

Read-only retained gradient value.

Examples

use tenferro_ad::{EagerRuntime, EagerTensor, Tensor};
use tenferro_cpu::CpuBackend;

let ctx = EagerRuntime::with_cpu_backend(CpuBackend::new())?;
let x = EagerTensor::requires_grad_in(
    Tensor::from_vec_col_major(vec![2], vec![2.0_f64, 3.0])?,
    ctx,
)?;
let loss = x.mul(&x)?.reduce_sum(Some(&[0]))?;
let _gradients = loss.backward()?;
let gradient = x.grad()?.expect("tracked leaf has a gradient");
assert_eq!(gradient.shape(), &[2]);

Implementations

impl GradientValue

pub fn dtype(&self) -> DType

Return the scalar dtype of the gradient.

pub fn shape(&self) -> &[usize]

Return the logical shape of the gradient.

pub fn value(&self) -> Result<ValueGuard<'_>>

Borrow the gradient’s value guard.

Errors

Returns Error::RuntimeState when the retained gradient record is unavailable or its allocation-group descriptor is invalid.

pub fn tensor_read(&self) -> Result<TensorRead<'_>>

Borrow the gradient as a dtype-erased read target.

Errors

Returns Error::RuntimeState when the retained gradient record or its allocation-group descriptor is unavailable.

pub fn as_slice<T: TensorScalar>(&self) -> Result<&[T]>

Borrow a compact host slice without downloading backend storage.

Errors

Returns Error::RuntimeState when the retained value is unavailable, tenferro_tensor::ValidationError::DTypeMismatch when T does not match the gradient dtype, or tenferro_tensor::Error::HostAccess when backend storage cannot be mapped as a host slice.

pub fn to_tensor(&self) -> Result<Tensor>

Explicitly copy a host-resident gradient into a standalone tensor.

Errors

Returns Error::RuntimeState when the retained value or execution session is unavailable, or a typed backend/host-access error when the gradient cannot be materialized as a contiguous tensor.

Trait Implementations

impl Clone for GradientValue

fn clone(&self) -> GradientValue

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GradientValue

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

Formats the value using the given formatter.