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

Add docs for GpuUsageLogger (#2945) 

* add docs

* fix spelling
This commit is contained in:
Nicki Skafte 2020-08-14 00:58:14 +02:00 committed by GitHub
parent cfd06a083b
commit 6a051c887f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 10 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/source/callbacks.rst
View File

@ -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:

2
pytorch_lightning/callbacks/gpu_usage_logger.py
View File

@ -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::