# kd.train

[[[Source]]](https://github.com/google-research/kauldron/tree/main/kauldron/train/__init__.py)

```{eval-rst}
.. automodule:: kauldron.train
  :no-members:
```

## Symbols


### Class

|  |  |
--- | ---
[kd.train.Auxiliaries](Auxiliaries) | Wrapper around the losses, summaries and metrics.
[kd.train.AuxiliariesOutput](AuxiliariesOutput) | Auxiliaries final values (after merge and compute).
[kd.train.AuxiliariesState](AuxiliariesState) | Auxiliaries (intermediate states to be accumulated).
[kd.train.Context](Context) | Namespace for retrieving information with path-based keys.
[kd.train.KDMetricWriter](KDMetricWriter) | Writes summaries to logs, tf_summaries and datatables.
[kd.train.RngStream](RngStream) | Info on one `rng` stream.
[kd.train.RngStreams](RngStreams) | Manager of rng streams.
[kd.train.Setup](Setup) | Setup/environment options.
[kd.train.TqdmInfo](TqdmInfo) | TqdmInfo(*, desc: 'str' = 'train', log_xm: 'bool' = True)
[kd.train.TrainState](TrainState) | Data structure for checkpointing the model.
[kd.train.TrainStep](TrainStep) | Base Training Step.
[kd.train.Trainer](Trainer) | Base trainer class.

### Function

|  |  |
--- | ---
[kd.train.forward](forward) | Forward pass of the model.
[kd.train.forward_with_loss](forward_with_loss) | Forward pass of the model, including losses.

```{toctree}
:hidden:

Auxiliaries
AuxiliariesOutput
AuxiliariesState
Context
KDMetricWriter
RngStream
RngStreams
Setup
TqdmInfo
TrainState
TrainStep
Trainer
forward
forward_with_loss
```