.. PyTorch Warmup documentation master file, created by
   sphinx-quickstart on Thu Oct 31 14:00:43 2019.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to PyTorch Warmup's documentation!
==========================================

This library contains PyTorch implementations of the warmup schedules described in
`On the adequacy of untuned warmup for adaptive optimization
<https://arxiv.org/abs/1910.04209>`_.

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

   manual_warmup
   untuned_warmup
   radam_warmup


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`