Struct tch::nn::Path

pub struct Path<'a> { /* fields omitted */ }

A variable store with an associated path for variables naming.

Implementations

impl<'a> Path<'a>

pub fn components(&self) -> impl Iterator<Item = &str>

Get the components of the path.

pub fn sub<T: ToString>(&self, s: T) -> Path<'a>

Gets a sub-path of the given path.

pub fn set_group(&self, group: usize) -> Path<'a>

pub fn device(&self) -> Device

Gets the device where the var-store variables are stored.

pub fn set_kind(&mut self, kind: Kind)

Casts all variables in a var store sub-path to the target kind .

Only the variable in the path sub-tree are cast to the target kind: other var store variables are unaffected. For floating-point conversion, methods half, bfloat16, float and double should be preferred as they ensure only float-like variables will be converted to the target type.

pub fn half(&mut self)

Casts all float-like variables in a var store sub-path to half-precision (Half kind).

Only the variable in the path sub-tree are cast to half-precision: other var store variables are unaffected

pub fn bfloat16(&mut self)

Casts all float-like variables in a var store sub-path to bfloat16-precision (BFloat16 kind).

Only the variable in the path sub-tree are cast to bfloat16-precision: other var store variables are unaffected

pub fn float(&mut self)

Casts all float-like variables in a var store sub-path to single-precision (Float kind).

Only the variable in the path sub-tree are cast to single-precision: other var store variables are unaffected

pub fn double(&mut self)

Casts all float-like variables in a var store sub-path to double-precision (Double kind).

Only the variable in the path sub-tree are cast to double-precision: other var store variables are unaffected

pub fn f_zeros_no_train(
    &self,
    name: &str,
    dims: &[i64]
) -> Result<Tensor, TchError>

Creates a new variable initialized with zeros.

The new variable is named according to the name parameter and has the specified shape. The variable will not be trainable so gradients will not be tracked. The variable uses a float tensor initialized with zeros.

pub fn f_ones_no_train(
    &self,
    name: &str,
    dims: &[i64]
) -> Result<Tensor, TchError>

Creates a new variable initialized with ones.

The new variable is named according to the name parameter and has the specified shape. The variable will not be trainable so gradients will not be tracked. The variable uses a float tensor initialized with ones.

pub fn f_var(
    &self,
    name: &str,
    dims: &[i64],
    init: Init
) -> Result<Tensor, TchError>

Creates a new variable.

The new variable is named according to the name parameter and has the specified shape. The variable is trainable, its gradient will be tracked. The variable uses a float tensor initialized as per the related argument.

pub fn f_zeros(&self, name: &str, dims: &[i64]) -> Result<Tensor, TchError>

Creates a new variable initialized with zeros.

The new variable is named according to the name parameter and has the specified shape. The variable is trainable, its gradient will be tracked. The variable uses a float tensor initialized with zeros.

pub fn f_ones(&self, name: &str, dims: &[i64]) -> Result<Tensor, TchError>

Creates a new variable initialized with ones.

The new variable is named according to the name parameter and has the specified shape. The variable is trainable, its gradient will be tracked. The variable uses a float tensor initialized with ones.

pub fn f_randn_standard(
    &self,
    name: &str,
    dims: &[i64]
) -> Result<Tensor, TchError>

Creates a new variable initialized randomly with normal distribution.

The new variable is named according to the name parameter and has the specified shape. The variable is trainable, its gradient will be tracked. The variable uses a float tensor initialized randomly using a standard normal distribution.

pub fn f_randn(
    &self,
    name: &str,
    dims: &[i64],
    mean: f64,
    stdev: f64
) -> Result<Tensor, TchError>

Creates a new variable initialized randomly with normal distribution.

The new variable is named according to the name parameter and has the specified shape. The variable is trainable, its gradient will be tracked. The variable uses a float tensor initialized randomly using a normal distribution with the specified mean and standard deviation.

pub fn f_uniform(
    &self,
    name: &str,
    dims: &[i64],
    lo: f64,
    up: f64
) -> Result<Tensor, TchError>

Creates a new variable initialized randomly with uniform distribution.

The new variable is named according to the name parameter and has the specified shape. The variable is trainable, its gradient will be tracked. The variable uses a float tensor initialized randomly using a uniform distribution between the specified bounds.

pub fn f_kaiming_uniform(
    &self,
    name: &str,
    dims: &[i64]
) -> Result<Tensor, TchError>

Creates a new variable initialized randomly with kaiming uniform.

The new variable is named according to the name parameter and has the specified shape. The variable is trainable, its gradient will be tracked. The variable uses a float tensor initialized randomly using a uniform distribution which bounds follow Kaiming initialization.

pub fn f_var_copy(&self, name: &str, t: &Tensor) -> Result<Tensor, TchError>

Creates a new variable initialized by copying an existing tensor.

The new variable is named according to the name parameter and has the specified shape. The variable is trainable, its gradient will be tracked. The variable uses a float tensor initialized by copying some given tensor.

pub fn zeros_no_train(&self, name: &str, dims: &[i64]) -> Tensor

Creates a new variable initialized with zeros.

The new variable is named according to the name parameter and has the specified shape. The variable will not be trainable so gradients will not be tracked. The variable uses a float tensor initialized with zeros.

pub fn ones_no_train(&self, name: &str, dims: &[i64]) -> Tensor

Creates a new variable initialized with ones.

The new variable is named according to the name parameter and has the specified shape. The variable will not be trainable so gradients will not be tracked. The variable uses a float tensor initialized with ones.

pub fn var(&self, name: &str, dims: &[i64], init: Init) -> Tensor

Creates a new variable.

The new variable is named according to the name parameter and has the specified shape. The variable is trainable, its gradient will be tracked. The variable uses a float tensor initialized as per the related argument.

pub fn zeros(&self, name: &str, dims: &[i64]) -> Tensor

Creates a new variable initialized with zeros.

The new variable is named according to the name parameter and has the specified shape. The variable is trainable, its gradient will be tracked. The variable uses a float tensor initialized with zeros.

pub fn ones(&self, name: &str, dims: &[i64]) -> Tensor

Creates a new variable initialized with ones.

The new variable is named according to the name parameter and has the specified shape. The variable is trainable, its gradient will be tracked. The variable uses a float tensor initialized with ones.

pub fn randn_standard(&self, name: &str, dims: &[i64]) -> Tensor

Creates a new variable initialized randomly with normal distribution.

The new variable is named according to the name parameter and has the specified shape. The variable is trainable, its gradient will be tracked. The variable uses a float tensor initialized randomly using a standard normal distribution.

pub fn randn(&self, name: &str, dims: &[i64], mean: f64, stdev: f64) -> Tensor

Creates a new variable initialized randomly with normal distribution.

The new variable is named according to the name parameter and has the specified shape. The variable is trainable, its gradient will be tracked. The variable uses a float tensor initialized randomly using a normal distribution with the specified mean and standard deviation.

pub fn uniform(&self, name: &str, dims: &[i64], lo: f64, up: f64) -> Tensor

Creates a new variable initialized randomly with uniform distribution.

The new variable is named according to the name parameter and has the specified shape. The variable is trainable, its gradient will be tracked. The variable uses a float tensor initialized randomly using a uniform distribution between the specified bounds.

pub fn kaiming_uniform(&self, name: &str, dims: &[i64]) -> Tensor

Creates a new variable initialized randomly with kaiming uniform.

The new variable is named according to the name parameter and has the specified shape. The variable is trainable, its gradient will be tracked. The variable uses a float tensor initialized randomly using a uniform distribution which bounds follow Kaiming initialization.

pub fn var_copy(&self, name: &str, t: &Tensor) -> Tensor

Creates a new variable initialized by copying an existing tensor.

The new variable is named according to the name parameter and has the specified shape. The variable is trainable, its gradient will be tracked. The variable uses a float tensor initialized by copying some given tensor.

pub fn get(&self, name: &str) -> Option<Tensor>

Gets the tensor corresponding to a given name if present.

pub fn entry<'b>(&'b self, name: &'b str) -> Entry<'b>

Gets the entry corresponding to a given name for in-place manipulation.

Trait Implementations

impl<'a> Debug for Path<'a>

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

Formats the value using the given formatter.

impl<'a, T> Div<T> for &mut Path<'a> where
    T: ToString, 

type Output = Path<'a>

The resulting type after applying the / operator.

fn div(self, rhs: T) -> Self::Output

Performs the / operation.

impl<'a, T> Div<T> for &Path<'a> where
    T: ToString, 

type Output = Path<'a>

The resulting type after applying the / operator.

fn div(self, rhs: T) -> Self::Output

Performs the / operation.