Skip to content

Commit

Permalink
doc
Browse files Browse the repository at this point in the history
  • Loading branch information
rohitgr7 committed Sep 22, 2021
1 parent 92a7045 commit 51bf84c
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions pytorch_lightning/trainer/trainer.py
Original file line number Diff line number Diff line change
Expand Up @@ -220,14 +220,15 @@ def __init__(
gpus: Number of GPUs to train on (int) or which GPUs to train on (list or str) applied per node
gradient_clip_val: The value at which to clip gradients. Passing ``gradient_clip_val=0`` disables gradient
clipping.
clipping. Default (None) which sets it's value to 0.0 internally.
.. deprecated:: v1.5
``gradient_clip_val`` has been deprecated in v1.5 and will be removed in v1.7.
Please configure gradient clipping directly in ``LightningModule.clip_gradients`` instead.
gradient_clip_algorithm: The gradient clipping algorithm to use. Pass ``gradient_clip_algorithm="value"``
for clip_by_value, and ``gradient_clip_algorithm="norm"`` for clip_by_norm.
for clip_by_value, and ``gradient_clip_algorithm="norm"`` for clip_by_norm. Default (None) which sets
it's value to "norm" internally.
.. deprecated:: v1.5
``gradient_clip_algorithm`` has been deprecated in v1.5 and will be removed in v1.7.
Expand Down

0 comments on commit 51bf84c

Please sign in to comment.