tools
=====

.. List the submodules



.. rubric:: Modules

.. autosummary::
   :toctree:
   :recursive:



   modelopt.torch.puzzletron.tools.checkpoint_utils



   modelopt.torch.puzzletron.tools.checkpoint_utils_hf



   modelopt.torch.puzzletron.tools.common



   modelopt.torch.puzzletron.tools.hydra_utils



   modelopt.torch.puzzletron.tools.kd_model



   modelopt.torch.puzzletron.tools.logger



   modelopt.torch.puzzletron.tools.post_init_sparse



   modelopt.torch.puzzletron.tools.robust_json



   modelopt.torch.puzzletron.tools.sharded_checkpoint_utils



   modelopt.torch.puzzletron.tools.validate_model



   modelopt.torch.puzzletron.tools.validate_puzzle_with_multi_replacements



   modelopt.torch.puzzletron.tools.validation_utils




.. Autodoc anything defined in the module itself

   TODO: WE DON'T USE THIS OPTION RIGHT NOW BUT WE CAN REACTIVATE IF WANTED
   We use :ignore-module-all: so sphinx does not document the same module twice, even if it is reimported
   For reimports that should be documented somewhere other than where they are defined, the re-imports
   __module__ should be manually overridden -- i.e. in the ``__init__.py`` which contains ``from xxx import YYY``,
   add in ``YYY.__module__ = __name__``.

.. automodule:: modelopt.torch.puzzletron.tools
   :members:
   :undoc-members:

   .. Also show members without docstrings. Only members from __all__ are considered as per conf.py
   .. Ideally we should add docstrings for these members.


   .. Overview table of available classes in the module
   
   
   


   .. Overview table of available functions in the module