candle-einops 0.2.0

Compile-time einops and einsum tensor operations for Candle
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58

use std::panic::{AssertUnwindSafe, catch_unwind};

use candle_core::{Device, Result, Tensor};
use candle_einops::einops;

#[test]
fn zero_decomposition_factor_returns_an_error() -> Result<()> {
    let input = Tensor::arange(0u32, 6, &Device::Cpu)?;

    let outcome = catch_unwind(AssertUnwindSafe(|| {
        einops!("(axis factor:0) -> axis factor", &input)
    }));

    assert!(outcome.is_ok(), "zero factor must not panic");
    let error = outcome.unwrap().unwrap_err();
    assert!(error.to_string().contains("must be non-zero"));
    Ok(())
}

#[test]
fn non_divisible_decomposition_returns_a_specific_error() -> Result<()> {
    let input = Tensor::arange(0u32, 5, &Device::Cpu)?;

    let error = einops!("(axis factor:2) -> axis factor", &input).unwrap_err();

    assert!(error.to_string().contains("not divisible"));
    Ok(())
}

#[test]
fn overflowing_runtime_factor_product_returns_an_error() -> Result<()> {
    let input = Tensor::new(&[1u32], &Device::Cpu)?;
    let large = usize::MAX;
    let two = 2usize;

    let outcome = catch_unwind(AssertUnwindSafe(|| {
        einops!("(axis {large} {two}) -> axis {large} {two}", &input)
    }));

    assert!(outcome.is_ok(), "factor overflow must not panic");
    let error = outcome.unwrap().unwrap_err();
    assert!(error.to_string().contains("factor product overflows usize"));
    Ok(())
}

#[test]
fn valid_inferred_decomposition_is_unchanged() -> Result<()> {
    let input = Tensor::arange(0u32, 12, &Device::Cpu)?;

    let output = einops!("(row column:3) -> row column", &input)?;

    assert_eq!(output.dims(), &[4, 3]);
    assert_eq!(
        output.to_vec2::<u32>()?,
        &[[0, 1, 2], [3, 4, 5], [6, 7, 8], [9, 10, 11]]
    );
    Ok(())
}