reax.Module
===========

.. currentmodule:: reax

.. autoclass:: Module

   
   .. automethod:: __init__

   
   .. rubric:: Methods

   .. autosummary::
   
      ~Module.__init__
      ~Module.attach
      ~Module.configure_listeners
      ~Module.configure_model
      ~Module.configure_optimizers
      ~Module.load_state
      ~Module.log
      ~Module.log_dict
      ~Module.on_before_optimizer_step
      ~Module.on_exception
      ~Module.on_fit_end
      ~Module.on_fit_start
      ~Module.on_predict_batch_end
      ~Module.on_predict_batch_start
      ~Module.on_predict_end
      ~Module.on_predict_epoch_end
      ~Module.on_predict_epoch_start
      ~Module.on_predict_start
      ~Module.on_stage_end
      ~Module.on_stage_iter_ending
      ~Module.on_stage_iter_starting
      ~Module.on_stage_start
      ~Module.on_test_batch_end
      ~Module.on_test_batch_start
      ~Module.on_test_end
      ~Module.on_test_epoch_end
      ~Module.on_test_epoch_start
      ~Module.on_test_start
      ~Module.on_train_batch_end
      ~Module.on_train_batch_start
      ~Module.on_train_end
      ~Module.on_train_epoch_end
      ~Module.on_train_epoch_start
      ~Module.on_train_start
      ~Module.on_validation_batch_end
      ~Module.on_validation_batch_start
      ~Module.on_validation_end
      ~Module.on_validation_epoch_end
      ~Module.on_validation_epoch_start
      ~Module.on_validation_start
      ~Module.optimizers
      ~Module.parameters
      ~Module.predict_dataloader
      ~Module.predict_step
      ~Module.prepare_data
      ~Module.set_parameters
      ~Module.setup
      ~Module.state_dict
      ~Module.teardown
      ~Module.test_dataloader
      ~Module.test_step
      ~Module.train_dataloader
      ~Module.training_step
      ~Module.val_dataloader
      ~Module.validation_step
   
   

   
   
   .. rubric:: Attributes

   .. autosummary::
   
      ~Module.automatic_optimization
      ~Module.current_epoch
      ~Module.global_step
      ~Module.global_updates
      ~Module.rngs
      ~Module.trainer
      ~Module.example_input_array