added module properties docs

2026-09-09 11:32:07 +08:00 · 2019-06-28 18:42:53 -04:00
parent e00d097c12
commit 0bdb8533c6
3 changed files with 28 additions and 4 deletions
@@ -0,0 +1,25 @@
+A LightningModule has the following properties which you can access at any time
+
+--- 
+#### current_epoch
+The current epoch   
+
+---
+#### dtype    
+Current dtype    
+
+--- 
+#### global_step
+Total training batches seen across all epochs   
+
+--- 
+#### gradient_clip
+The current gradient clip value    
+
+---
+#### on_gpu    
+True if your model is currently running on GPUs. Useful to set flags around the LightningModule for different CPU vs GPU behavior.    
+
+---
+#### Trainer
+Last resort access to any state the trainer has. Changing certain properties here could affect your training run.