API Reference

Rustdoc

tenferro is the main user-facing crate. See the Rustdoc API documentation.

For contributors, internal crate APIs are also available in the full workspace Rustdoc index.

Workspace Crates

  • tenferro: traced frontend, execution engine, public einsum API, public linalg API, and AD entry points (VJP/JVP/HVP)
  • tenferro-tensor: concrete dense Tensor / TypedTensor values, backend traits, CPU backend, and GPU backend stubs
  • tenferro-einsum: subscripts, contraction trees, contraction optimization, and fragment-building helpers
  • tenferro-ops: graph op vocabulary and AD rule implementations for StdTensorOp
  • tenferro-algebra: semiring and algebra traits
  • tenferro-device: shared device and error types

Architecture Summary

tenferro-device
    |
tenferro-algebra
    |
tenferro-tensor   -- dense runtime tensors, TensorBackend, CpuBackend
    |
tenferro-ops      -- StdTensorOp / SemiringOp, PrimitiveOp rules
    |
tenferro-einsum   -- subscripts + contraction planning + fragment builder
    |
tenferro          -- Engine, TracedTensor, lowering, execution, public APIs