``tmrc``: The Kempner Transformer Model Research Codebase
===========================================

``tmrc`` (**T**\ ransformer **M**\ odel **R**\ esearch **C**\ odebase) is a simple, explainable codebase to train transformer-based models. It was developed with simplicity and ease of modification in mind, particularly for researchers.  The codebase will eventually be used to train foundation models and experiment with architectural and training modifications. 

.. toctree::
   :maxdepth: 2
   :caption: Getting Started

   getting_started

.. toctree::
   :maxdepth: 1
   :caption: Training confirguations

   training_config


.. toctree::
   :maxdepth: 2
   :caption: Contents

   source/tmrc
   source/modules



