Struct Engine 

pub struct Engine<B: TensorBackend> { /* private fields */ }

Execution engine holding the backend and compile caches.

Examples

use tenferro_tensor::cpu::CpuBackend;
use tenferro::engine::Engine;

let mut engine = Engine::new(CpuBackend::new());

Implementations

impl<B: TensorBackend> Engine<B>

pub fn new(backend: B) -> Self

Create a new engine with the given backend.

Examples

use tenferro_tensor::cpu::CpuBackend;
use tenferro::engine::Engine;

let engine = Engine::new(CpuBackend::new());

pub fn backend(&self) -> &B

Borrow the backend used by this engine.

Examples

use tenferro::{CpuBackend, Engine};

let engine = Engine::new(CpuBackend::new());
let _backend = engine.backend();

pub fn einsum_cache_len(&self) -> usize

Number of cached einsum contraction trees currently retained by the engine.

Examples

use tenferro::{CpuBackend, Engine};

let engine = Engine::new(CpuBackend::new());
assert_eq!(engine.einsum_cache_len(), 0);

pub fn with_einsum_cache_capacity(backend: B, capacity: NonZeroUsize) -> Self

Construct a new engine with an explicit einsum_cache capacity.

Examples

use std::num::NonZeroUsize;
use tenferro::{CpuBackend, Engine};

let engine = Engine::with_einsum_cache_capacity(
    CpuBackend::new(),
    NonZeroUsize::new(64).unwrap(),
);

pub fn einsum_cache_capacity(&self) -> NonZeroUsize

Current capacity of the einsum contraction-tree cache.

Examples

use tenferro::{CpuBackend, Engine};

let engine = Engine::new(CpuBackend::new());
assert_eq!(engine.einsum_cache_capacity().get(), tenferro::engine::DEFAULT_EINSUM_CACHE_CAPACITY);

pub fn set_einsum_cache_capacity(&mut self, capacity: NonZeroUsize)

Resize the einsum contraction-tree cache.

Shrinking below the current length evicts least-recently-used entries.

Examples

use std::num::NonZeroUsize;
use tenferro::{CpuBackend, Engine};

let mut engine = Engine::new(CpuBackend::new());
engine.set_einsum_cache_capacity(NonZeroUsize::new(32).unwrap());

pub fn einsum_cache_contains(&self, key: &(String, Vec<Vec<usize>>)) -> bool

Returns true if the einsum cache contains a tree for key.

Does not modify LRU recency.

Examples

use tenferro::{CpuBackend, Engine};

let engine = Engine::new(CpuBackend::new());
let key = ("ij,jk->ik".to_string(), vec![vec![2, 3], vec![3, 4]]);
assert!(!engine.einsum_cache_contains(&key));

pub fn eval_exec_ir( &mut self, program: &ExecProgram, inputs: Vec<Tensor>, ) -> Result<Vec<Tensor>>

Evaluate an ExecProgram through this engine, reusing the persistent einsum_cache for any NaryEinsum ops encountered in the program.

Examples

use tenferro::{CpuBackend, Engine};
use tenferro::exec::ExecProgram;

let mut engine = Engine::new(CpuBackend::new());
// let outputs = engine.eval_exec_ir(&program, inputs)?;

impl Engine<CpuBackend>

pub fn buffer_pool_len(&self) -> usize

Number of reusable typed host buffers currently retained by the CPU backend.

Examples

use tenferro::{CpuBackend, Engine};

let engine = Engine::new(CpuBackend::new());
assert_eq!(engine.buffer_pool_len(), 0);