API reference#
The library has two documented layers (see User guide “Frontend and backend”):
the frontend – classes re-exported at the package root (
import t3toolbox);the backend – stateless functions on raw
.datatuples, imported explicitly by submodule (from t3toolbox.backend import probing). The backend is a first-class surface: everything the frontend does is available here.
The frontend surface#
Everything below is importable directly from t3toolbox.
Tensors
TuckerTensorTrain– the keystone class (ragged);.data = (tucker_cores, tt_cores).UniformTuckerTensorTrain– the uniform (supercores + masks) mirror.
Frames, variations, tangents
T3Frame,T3Variations,t3_orthogonal_representations()– the orthogonal frame + gauged variations of a tangent direction.T3Tangent– a tangent vector: one (frame, variations) pair.UT3Frame,UT3Variations,ut3_orthogonal_representations(),UT3Tangent– the uniform mirrors.
Geometries
MANIFOLD/COREWISE(inmanifold) – the Hilbert-Schmidt manifold geometry and the Euclidean coordinate geometry.UNIFORM_MANIFOLD/UNIFORM_COREWISE(inuniform_manifold) – their uniform twins.
Fitting and optimization
GaussNewtonModel,UniformGaussNewtonModel– the geometry-generic local models.The six model factories (in
fitting):entries_model(),apply_model(),probe_model(),entries_derivatives_model(),apply_derivatives_model(),probe_derivatives_model().The four optimizers (in
optimizers):gradient_descent(),mc_sgd(),adam(),newton_cg(). Ragged vs uniform is inferred from the initial guessx0.
Safety
The backend surface#
Backend modules follow the family-prefix grammar (t3_ ragged tensor, ut3_ uniform tensor,
tv_/utv_ tangent-variations, fv_/ufv_ frame-variations, tt_ bare TT chains,
dense_ dense reference) – the complete grammar, module map, and deliberate exceptions are in
Naming conventions. By area:
Core families:
t3_constructors,t3_conversions,t3_operations,t3_linalg,t3_orthogonalization,t3_svd, and the uniform mirrors (ut3_constructors,ut3_conversions,ut3_operations,ut3_linalg,ut3_orthogonalization,ut3_svd,ut3_masking), plustt_operationsandtt_orthogonalizationfor bare TT chains.Frames, variations, tangents:
fv_conversions,fv_operations,tv_operations, and the uniform mirrors (ufv_conversions,ufv_masking,ufv_operations,utv_operations).Sampling (grouped by sampling type, the deliberate exception):
probing,apply,entries,sampling_derivatives, and the uniform object-type wrappersut3_sampling,utv_sampling.Fitting and optimization:
fitting,optimizers,uniform_fitting.Infrastructure:
common,contractions,stacking,linalg,ranks.
Note
The rendered signatures on the module pages are regenerated from the parsed source, so each function page also shows the verbatim source signature – including the trailing shape-contract comments, which are the real type contract (Signature style — shape comments as the real type system).