log_learning_rate

health_ml.utils.log_learning_rate(module, name='learning_rate')[source]

Logs the learning rate(s) used by the given module. Multiple learning rate schedulers and/or multiple rates per scheduler are supported. The learning rates are logged under the given name. If multiple scheduler and/or multiple rates are used, a suffix like “/0/1” is added, to indicate the learning rate for scheduler 0, index 1, for example. Learning rates are logged on epoch.

Parameters
  • module (LightningModule) – The module for which the learning rates should be logged.

  • name (str) – The name to use when logging the learning rates.

Return type

None