:mod:`train`
============

.. py:module:: train

.. autoapi-nested-parse::

   Primary training and evaluation script. Run ``python3 train.py -h`` to see available
   options.



Module Contents
---------------

.. function:: main(hparams)

   Main training routine specific for this project

   :param hparams: Namespace containing configuration values
   :type hparams: Namespace


.. function:: set_hparams(hparams)

   Add constant parameter values based on passed arguments.

   :param hparams: Parameters
   :type hparams: Namespace
   :return: Modified parameters
   :rtype: Namespace


.. function:: get_model(hparams)

   Prepare model and the data.

   :param hparams: Holds configuration values.
   :type hparams: Namespace
   :raises ImportError: The requested model and prediction data must be compatible.
   :return: Model with the linked data.
   :rtype: Model