|
| | TiedLMHeadModule (EmbeddingModule &embedding, DeviceBackend *backend) |
| |
| Tensor | backward (const Tensor &grad_output) override |
| | Input gradient grad @ E; adds grad^T @ x into the embedding's weight gradient unless the embedding is frozen.
|
| |
| Tensor | propagate_relevance (const Tensor &relevance_out, const LRPRuleConfig &config) override |
| | LRP through x @ E^T, by config.rule (Epsilon, Gamma, AlphaBeta or ZBox).
|
| |
| bool | supports_lrp_rule (LRPRule) const override |
| | Whether propagate_relevance() implements rule (no silent fallback: callers such as ExplainerContext::relevance_pass() throw rather than run a module on a rule it does not implement).
|
| |
| OpType | op_type () const override |
| | This module's operation-category tag, for ComputationGraph node tagging.
|
| |
| std::vector< NamedParamRef > | named_parameters () override |
| | Empty: the shared table is the embedding's parameter, not the head's.
|
| |
| int64_t | vocab_size () const |
| |
| int64_t | d_model () const |
| |
| std::optional< DeviceType > | compute_device () const override |
| | The device this module computes on, so forward() can reject an input on another device before any kernel sees it (roadmap FND-8).
|
| |
| void | release_activations () override |
| | Frees the tensors forward() kept for backward() and the relevance passes; containers release their children too. Inference that only needs the output calls it after each forward, so a deep model holds one layer's activations at a time (a 1024-token ESM-2 650M pass otherwise keeps over 10 GB of them).
|
| |
| virtual | ~Module ()=default |
| |
| Tensor | forward (const Tensor &input) |
| | Runs this module's forward computation.
|
| |
| std::pair< Tensor, NodeId > | forward_traced (const Tensor &input, NodeId input_node, ComputationGraph &graph, Autograd &autograd) |
| | Runs forward() while also registering a ComputationGraph node (tagged with this module's op_type(), parented to input_node) and wiring an Autograd backward function that reuses this module's own backward() – the opt-in traced/explainable path, per Phase 2 Mission 0.
|
| |
| virtual std::vector< NamedBufferRef > | named_buffers () |
| | This module's buffers: state a checkpoint must save that no optimizer updates.
|
| |
| virtual std::vector< NamedModuleRef > | named_children () |
| | This module's direct sub-modules, each under the prefix its parameters carry in named_parameters(), in the same order (TRN-7: how ApplyLora() finds a model's Linear layers). Default: none. NamedModules() walks the whole tree.
|
| |
| virtual std::vector< ParamRef > | parameters () |
| | This module's trainable parameters and their gradients, for an optimizer to update uniformly across module types.
|
| |
| void | set_requires_grad (bool requires_grad, const std::string &prefix="") |
| | Freezes (false) or unfreezes (true) parameters by name (roadmap FND-2).
|
| |
| virtual void | set_training (bool training) |
| | Sets this module's training/eval mode. Defaults to training (matches every mainstream framework's Module default).
|
| |
| bool | is_training () const |
| | Whether this module is currently in training mode.
|
| |
logits = x @ E^T, where E is a token embedding table (vocab, d_model) that the head shares rather than copies – Hugging Face's tie_word_embeddings (SmolLM2, Qwen3, Gemma 3). Shape (..., d_model) -> (..., vocab).
- Note
- One parameter, two uses. The head holds no weight of its own: it reads the embedding's table and accumulates its gradient into the embedding's gradient buffer, so the table's gradient is the sum of both uses, as in PyTorch. named_parameters() is therefore empty – the optimizer, freezing and checkpoints see the table once, under the embedding's name. Freezing the embedding freezes the head too.
-
No bias, as in every tied model. An untied head is a bias-free LinearModule.
-
LRP is the affine layer's rule with the transposed table as its weight: every LRPRule LinearModule supports, with the same Zennit semantics. With no bias, the epsilon rule's two bias conventions agree, and it conserves relevance up to the stabilizer.
-
The embedding must outlive this module, and stay on the same backend.