lightning/docs/LightningModule/properties.md

41 lines
925 B
Markdown
Raw Normal View History

2019-06-28 22:42:53 +00:00
A LightningModule has the following properties which you can access at any time
---
#### current_epoch
The current epoch
---
#### dtype
Current dtype
2019-06-29 22:14:45 +00:00
---
#### experiment
An instance of test-tube Experiment which you can use to log anything for tensorboarX.
```{.python}
self.experiment.add_embedding(...)
self.experiment.log({'val_loss': 0.9})
self.experiment.add_scalars(...)
```
2019-06-28 22:42:53 +00:00
---
2019-06-29 22:14:45 +00:00
#### global_step
2019-06-28 22:42:53 +00:00
Total training batches seen across all epochs
---
2019-06-29 22:14:45 +00:00
#### gradient_clip
2019-06-28 22:42:53 +00:00
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.
---
2019-06-29 22:14:45 +00:00
#### trainer
2019-06-28 22:42:53 +00:00
Last resort access to any state the trainer has. Changing certain properties here could affect your training run.
2019-06-29 22:14:45 +00:00
```{.python}
self.trainer.optimizers
self.trainer.current_epoch
...
```