Tutorials

These tutorials are ordered, runnable introductions to the main tenferro workflows. They complement the guides: tutorials show one complete path, while guides describe the broader APIs and tradeoffs.

Short tutorial programs in this section are sourced from docs/tutorial-code and are run by the workspace test workflow. Extension tutorials live in standalone nested crates under ext/ and are tested through their manifest paths. Longer application samples, such as the KdV PINN tutorial, point at standalone sample packages and may use compile-only CI coverage when execution would be too slow for every pull request.

Suggested Order

Tutorial	Use it when
TypedTensor for numeric computation without autodiff	You know the scalar type in Rust and want ndarray-like CPU tensor computation without AD.
Eager autodiff, PyTorch style	You want immediate execution, scalar losses, backward(), accumulated gradients, or the broader functional eager AD entry point.
Traced autodiff, JAX style	You want to build a graph, compile/run it, and use grad or jvp on the traced graph.
Einsum: subscripts to gradients	You contract more than two tensors and want planned contraction order plus AD.
XLA backend: einsum to StableHLO	You want to lower a fixed-shape N-ary einsum path through the experimental XLA executor.
Dynamic shapes: truncated SVD	Output ranks depend on runtime values such as singular-value thresholds.
Tropical extension	You want a complete extension crate for non-standard arithmetic, runtime registration, and AD rules.
Sparse tensor extension	You want a fixed-pattern sparse COO extension with sparse-sparse contraction and value AD.
KdV PINN sample	You want a full traced-graph PINN training loop with PDE residuals and scalar loss gradients.

Running The Tutorial Code

From the repository root:

cargo test -p tenferro-tutorial-code --release

The CI workflow runs this package through the existing workspace test command, so tutorial execution does not add a second tenferro compilation step after unit tests.

The tropical and sparse extension tutorials are tested as standalone crates:

cargo test --manifest-path ext/tropical/Cargo.toml --release --features autodiff
cargo test --manifest-path ext/sparse/Cargo.toml --release --features autodiff

The KdV PINN sample is compile-checked separately:

cargo check --manifest-path samples/kdv-pinn/Cargo.toml --release --all-targets