From 7fd2b0fa19e8ed3db08e14ffbaa64e715a1fdd03 Mon Sep 17 00:00:00 2001 From: William Falcon Date: Sat, 29 Jun 2019 18:14:45 -0400 Subject: [PATCH] added module properties --- docs/LightningModule/properties.md | 21 ++++++++++++++++++--- 1 file changed, 18 insertions(+), 3 deletions(-) diff --git a/docs/LightningModule/properties.md b/docs/LightningModule/properties.md index 7502046b90..060f2ec8f3 100644 --- a/docs/LightningModule/properties.md +++ b/docs/LightningModule/properties.md @@ -8,12 +8,21 @@ The current epoch #### dtype Current dtype +--- +#### 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(...) +``` + --- -#### global_step +#### global_step Total training batches seen across all epochs --- -#### gradient_clip +#### gradient_clip The current gradient clip value --- @@ -21,5 +30,11 @@ The current gradient clip value True if your model is currently running on GPUs. Useful to set flags around the LightningModule for different CPU vs GPU behavior. --- -#### Trainer +#### trainer Last resort access to any state the trainer has. Changing certain properties here could affect your training run. +```{.python} +self.trainer.optimizers +self.trainer.current_epoch +... +``` +