diff --git a/docs/source/callbacks.rst b/docs/source/callbacks.rst index 40ed5387b7..d4396ad31c 100644 --- a/docs/source/callbacks.rst +++ b/docs/source/callbacks.rst @@ -101,6 +101,15 @@ Lightning has a few built-in callbacks. ---------------- +.. automodule:: pytorch_lightning.callbacks.gpu_usage_logger + :noindex: + :exclude-members: + _get_gpu_stat, + _log_gpu, + _log_memory + +---------------- + .. automodule:: pytorch_lightning.callbacks.gradient_accumulation_scheduler :noindex: :exclude-members: diff --git a/pytorch_lightning/callbacks/gpu_usage_logger.py b/pytorch_lightning/callbacks/gpu_usage_logger.py index 426fff444d..e4496ca81d 100644 --- a/pytorch_lightning/callbacks/gpu_usage_logger.py +++ b/pytorch_lightning/callbacks/gpu_usage_logger.py @@ -28,7 +28,7 @@ class GpuUsageLogger(Callback): intra_step_time: Set to ``True`` to log the time of each step. Default: ``False`` inter_step_time: Set to ``True`` to log the time between the end of one step and the start of the next. Default: ``False`` - fan_speed: Set to ``False`` to log percentage of fan speed. Default: ``False``. + fan_speed: Set to ``True`` to log percentage of fan speed. Default: ``False``. temperature: Set to ``True`` to log the memory and gpu temperature in degrees C. Default: ``False`` Example::