viva_tensor/axis

Axis - Named axis types for semantic tensor dimensions

Gives meaning to tensor dimensions: Batch, Seq, Feature, etc.

Types

Axis

Named axis - gives semantic meaning to a dimension

pub type Axis {
  Batch
  Seq
  Feature
  Height
  Width
  Channel
  Input
  Output
  Head
  Embed
  Named(String)
  Anon
}

Constructors

```
Batch
```
Batch dimension (samples in mini-batch)
```
Seq
```
Sequence/time dimension (for RNNs, transformers)
```
Feature
```
Feature/channel dimension
```
Height
```
Spatial height
```
Width
```
Spatial width
```
Channel
```
Channel dimension (for images)
```
Input
```
Input dimension (for weight matrices)
```
Output
```
Output dimension (for weight matrices)
```
Head
```
Head dimension (for multi-head attention)
```
Embed
```
Embedding dimension
```
Named(String)
```
Custom named axis
```
Anon
```
Anonymous axis (unnamed, referenced by position)

AxisSpec

</>

Axis with its size

pub type AxisSpec {
  AxisSpec(name: Axis, size: Int)
}

Constructors

```
AxisSpec(name: Axis, size: Int)
```

Values

axis

</>

pub fn axis(name: Axis, size: Int) -> AxisSpec

Create axis spec

batch

</>

pub fn batch(size: Int) -> AxisSpec

Batch dimension

channel

</>

pub fn channel(size: Int) -> AxisSpec

Channel dimension

embed

</>

pub fn embed(size: Int) -> AxisSpec

Embed dimension

equals

</>

pub fn equals(a: Axis, b: Axis) -> Bool

Check if two axes are equal

feature

</>

pub fn feature(size: Int) -> AxisSpec

Feature dimension

head

</>

pub fn head(size: Int) -> AxisSpec

Head dimension

height

</>

pub fn height(size: Int) -> AxisSpec

Height dimension

input

</>

pub fn input(size: Int) -> AxisSpec

Input dimension

named

</>

pub fn named(name: String, size: Int) -> AxisSpec

Custom named dimension

output

</>

pub fn output(size: Int) -> AxisSpec

Output dimension

seq

</>

pub fn seq(size: Int) -> AxisSpec

Sequence dimension

specs_equal

</>

pub fn specs_equal(a: List(AxisSpec), b: List(AxisSpec)) -> Bool

Check if two axis spec lists are equal

to_string

</>

pub fn to_string(a: Axis) -> String

Get human-readable axis name

width

</>

pub fn width(size: Int) -> AxisSpec

Width dimension