viva_tensor/named

Named Tensor - Tensors with semantic axis names

Wrap tensors with named axes for clearer, safer operations. Instead of sum(t, axis: 0), write sum(t, along: Batch)

Types

NamedTensor

Tensor with named axes

pub type NamedTensor {
  NamedTensor(data: tensor.Tensor, axes: List(axis.AxisSpec))
}

Constructors

```
NamedTensor(data: tensor.Tensor, axes: List(axis.AxisSpec))
```
Arguments

data

Underlying data tensor

axes

Axis specifications (names + sizes, in order)

NamedTensorError

</>

Error types for named tensor operations

pub type NamedTensorError {
  AxisNotFound(name: axis.Axis)
  DuplicateAxis(name: axis.Axis)
  AxisMismatch(expected: axis.Axis, got: axis.Axis)
  SizeMismatch(axis: axis.Axis, expected: Int, got: Int)
  BroadcastErr(reason: String)
  TensorErr(error.TensorError)
  InvalidOp(reason: String)
}

Constructors

```
AxisNotFound(name: axis.Axis)
```
Axis not found
```
DuplicateAxis(name: axis.Axis)
```
Duplicate axis name

AxisMismatch(expected: axis.Axis, got: axis.Axis)

Axis mismatch in operation

SizeMismatch(axis: axis.Axis, expected: Int, got: Int)

Size mismatch for same axis

```
BroadcastErr(reason: String)
```
Cannot broadcast axes
```
TensorErr(error.TensorError)
```
Underlying tensor error
```
InvalidOp(reason: String)
```
Invalid operation

Values

add

</>

pub fn add(
  a: NamedTensor,
  b: NamedTensor,
) -> Result(NamedTensor, NamedTensorError)

Element-wise add (same axes required)

axis_names

</>

pub fn axis_names(t: NamedTensor) -> List(axis.Axis)

Get all axis names

axis_size

</>

pub fn axis_size(
  t: NamedTensor,
  name: axis.Axis,
) -> Result(Int, NamedTensorError)

Get axis size by name

describe

</>

pub fn describe(t: NamedTensor) -> String

Pretty print tensor info

find_axis

</>

pub fn find_axis(
  t: NamedTensor,
  name: axis.Axis,
) -> Result(Int, NamedTensorError)

Find axis index by name

from_tensor

</>

pub fn from_tensor(t: tensor.Tensor) -> NamedTensor

Create from tensor with inferred anonymous axes

has_axis

</>

pub fn has_axis(t: NamedTensor, name: axis.Axis) -> Bool

Check if tensor has axis

map

</>

pub fn map(t: NamedTensor, f: fn(Float) -> Float) -> NamedTensor

Map function over elements

mean_along

</>

pub fn mean_along(
  t: NamedTensor,
  axis_name: axis.Axis,
) -> Result(NamedTensor, NamedTensorError)

Mean along named axis

mul

</>

pub fn mul(
  a: NamedTensor,
  b: NamedTensor,
) -> Result(NamedTensor, NamedTensorError)

Element-wise mul (same axes required)

new

</>

pub fn new(
  data: tensor.Tensor,
  axes: List(axis.AxisSpec),
) -> Result(NamedTensor, NamedTensorError)

Create named tensor from data and axis specs

ones

</>

pub fn ones(axes: List(axis.AxisSpec)) -> NamedTensor

Create named tensor of ones

randn

</>

pub fn randn(
  axes: List(axis.AxisSpec),
  mean: Float,
  std: Float,
) -> NamedTensor

Create named tensor with normal distribution

random

</>

pub fn random(axes: List(axis.AxisSpec)) -> NamedTensor

Create named tensor with random values [0, 1)

rank

</>

pub fn rank(t: NamedTensor) -> Int

Get rank (number of dimensions)

rename_axis

</>

pub fn rename_axis(
  t: NamedTensor,
  from: axis.Axis,
  to: axis.Axis,
) -> Result(NamedTensor, NamedTensorError)

Rename an axis

scale

</>

pub fn scale(t: NamedTensor, s: Float) -> NamedTensor

Scale by constant

shape

</>

pub fn shape(t: NamedTensor) -> List(Int)

Get shape as list

size

</>

pub fn size(t: NamedTensor) -> Int

Total number of elements

squeeze

</>

pub fn squeeze(
  t: NamedTensor,
  name: axis.Axis,
) -> Result(NamedTensor, NamedTensorError)

Remove axis of size 1 by name

sum_along

</>

pub fn sum_along(
  t: NamedTensor,
  axis_name: axis.Axis,
) -> Result(NamedTensor, NamedTensorError)

Sum along named axis

to_tensor

</>

pub fn to_tensor(t: NamedTensor) -> tensor.Tensor

Convert to plain tensor (drop names)

unsqueeze

</>

pub fn unsqueeze(
  t: NamedTensor,
  name: axis.Axis,
  position: Int,
) -> NamedTensor

Add a new axis of size 1

zeros

</>

pub fn zeros(axes: List(axis.AxisSpec)) -> NamedTensor

Create named tensor of zeros

Constructors

Arguments

Constructors