Skip to content

Fix typos in docstring #105

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 24, 2025
Merged

Fix typos in docstring #105

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions torch_lr_finder/lr_finder.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -275,8 +275,8 @@ def range_test(
>>> acc_lr_finder = LRFinder(net, optimizer, criterion, device="cuda")
>>> acc_lr_finder.range_test(dataloader, end_lr=10, num_iter=100, accumulation_steps=accumulation_steps)

If your DataLoader returns e.g. dict, or other non standard output, intehit from TrainDataLoaderIter,
redefine method `inputs_labels_from_batch` so that it outputs (inputs, lables) data:
If your DataLoader returns e.g. dict, or other non standard output, inherit from TrainDataLoaderIter,
redefine method `inputs_labels_from_batch` so that it outputs (inputs, labels) data:
>>> import torch_lr_finder
>>> class TrainIter(torch_lr_finder.TrainDataLoaderIter):
>>> def inputs_labels_from_batch(self, batch_data):
Expand Down