termux-train Logo

termux-train

v0.1.0 (Native)
PyPI (pip) 💖 Sponsor GitHub

100% Full API Reference

Complete specification of Tensor, Module, Optimizer, Checkpoint, and Tokenizer classes.

1. Core Tensor Module (termux_train.Tensor)

Method / PropertySignatureDescription
Tensor(data, requires_grad)(data: Any, requires_grad: bool = False, dtype: str = 'float32')Constructs a dynamic autograd graph node.
backward()(gradient: Optional[Tensor] = None)Executes reverse-mode DAG automatic differentiation.
zero_grad()(set_to_none: bool = True)Resets gradients (set_to_none=True optimizes mobile RAM).
@ (matmul)(other: Tensor) -> Tensor1D~3D matrix multiplication (all 9 rank combinations).

2. Neural Network Layers (termux_train.nn)

ClassKey Constructor ParametersDescription
nn.Linearin_features: int, out_features: int, bias: bool = TrueFully-connected linear transformation layer.
nn.LoRALinearin_features: int, out_features: int, rank: int = 4, alpha: float = 8.0Low-Rank Adaptation parameter-efficient adapter layer.
nn.Embeddingnum_embeddings: int, embedding_dim: intLookup table for discrete token embeddings.
nn.LayerNormnormalized_shape: int, eps: float = 1e-5Channel layer normalization.
nn.RotaryEmbeddingdim: int, max_position_embeddings: int = 2048Rotary Position Embedding (RoPE) with O(0) learnable weights.
nn.TinyTransformerLMvocab_size, d_model, num_heads, d_ff, num_layers, pos_typeComplete Decoder Transformer with RoPE & KV Cache.

3. Optimizers & Serialization

Function / ClassModuleDescription
optim.AdamWtermux_train.optimDecoupled weight decay Adam optimizer.
checkpoint.save_safetensorstermux_train.checkpointHuggingFace-compatible zero-copy binary serialization.
checkpoint.save_lora_adaptertermux_train.checkpointSaves low-rank matrices only (<100KB adapter footprint).