Rooba
/
lightning
mirror of https://github.com/Lightning-AI/lightning.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

add 'sanity_checking' to datamodule 'on_after_batch_transfer' docs (#10067) 

Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>
This commit is contained in:
Charlie_Tang 2021-10-26 19:12:57 +08:00 committed by GitHub
parent a5235d5b01
commit 84ce1d095c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/source/extensions/datamodules.rst
View File

@ -303,7 +303,7 @@ Returns a special dataloader for inference. This is the dataloader that the Trai
transfer_batch_to_device
^^^^^^^^^^^^^^^^^^^^^^^^
Override to define how you want to move an arbitrary batch to a device.
To check the current state of execution of this hook you can use ``self.trainer.training/testing/validating/predicting``
To check the current state of execution of this hook you can use ``self.trainer.training/testing/validating/predicting/sanity_checking``
so that you can add different logic as per your requirement.
.. testcode::
@ -322,7 +322,7 @@ so that you can add different logic as per your requirement.
on_before_batch_transfer
^^^^^^^^^^^^^^^^^^^^^^^^
Override to alter or apply augmentations to your batch before it is transferred to the device.
To check the current state of execution of this hook you can use ``self.trainer.training/testing/validating/predicting``
To check the current state of execution of this hook you can use ``self.trainer.training/testing/validating/predicting/sanity_checking``
so that you can add different logic as per your requirement.
.. testcode::
@ -339,7 +339,7 @@ so that you can add different logic as per your requirement.
on_after_batch_transfer
^^^^^^^^^^^^^^^^^^^^^^^
Override to alter or apply augmentations to your batch after it is transferred to the device.
To check the current state of execution of this hook you can use ``self.trainer.training/testing/validating/predicting``
To check the current state of execution of this hook you can use ``self.trainer.training/testing/validating/predicting/sanity_checking``
so that you can add different logic as per your requirement.
.. testcode::