Correct LBFGS tolerance_grad doc string (#99792)

arthurfeeney · pytorchmergebot · commit 7a8d0ccddff9 · 2023-04-22T20:19:01.000Z
LBFGS' `tolerance_grad` parameter has had a default value of `1e-7` since #25240. The doc string wasn't updated in that PR to match the change https://github.com/pytorch/pytorch/blob/main/torch/optim/lbfgs.py#L207. no open issue for it, just happened to set it to 1e-7 and was surprised my results didn't change :-) eventually noticed inconsistency in the doc and seemed like an easy opportunity to figure out how to contribute. Pull Request resolved: #99792 Approved by: https://github.com/janeyx99
diff --git a/torch/optim/lbfgs.py b/torch/optim/lbfgs.py
@@ -205,7 +205,7 @@ class LBFGS(Optimizer):
         max_eval (int): maximal number of function evaluations per optimization
             step (default: max_iter * 1.25).
         tolerance_grad (float): termination tolerance on first order optimality
-            (default: 1e-5).
+            (default: 1e-7).
         tolerance_change (float): termination tolerance on function
             value/parameter changes (default: 1e-9).
         history_size (int): update history size (default: 100).
