Skip to content

Commit d500bec

Browse files
committed
small doc fixes
1 parent ce7508b commit d500bec

File tree

2 files changed

+2
-19
lines changed

2 files changed

+2
-19
lines changed

src/lightning/pytorch/callbacks/lr_finder.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ def __init__(
106106
self._attr_name = attr_name
107107

108108
self._early_exit = False
109-
self.lr_finder: Optional[_LRFinder] = None
109+
self.optimal_lr: Optional[_LRFinder] = None
110110

111111
def lr_find(self, trainer: "pl.Trainer", pl_module: "pl.LightningModule") -> None:
112112
with isolate_rng():

src/lightning/pytorch/tuner/lr_finder.py

Lines changed: 1 addition & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -71,26 +71,10 @@ class _LRFinder:
7171
7272
Args:
7373
mode: either `linear` or `exponential`, how to increase lr after each step
74-
7574
lr_min: lr to start search from
76-
7775
lr_max: lr to stop search
78-
7976
num_training: number of steps to take between lr_min and lr_max
8077
81-
Example::
82-
# Run lr finder
83-
lr_finder = trainer.lr_find(model)
84-
85-
# Results stored in
86-
lr_finder.results
87-
88-
# Plot using
89-
lr_finder.plot()
90-
91-
# Get suggestion
92-
lr = lr_finder.suggestion()
93-
9478
"""
9579

9680
def __init__(self, mode: str, lr_min: float, lr_max: float, num_training: int) -> None:
@@ -138,10 +122,9 @@ def plot(
138122
"""Plot results from lr_find run
139123
Args:
140124
suggest: if True, will mark suggested lr to use with a red point
141-
142125
show: if True, will show figure
143-
144126
ax: Axes object to which the plot is to be drawn. If not provided, a new figure is created.
127+
145128
"""
146129
if not _MATPLOTLIB_AVAILABLE:
147130
raise MisconfigurationException(

0 commit comments

Comments
 (0)