Skip to content

Better name for Tuner methods #16529

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.

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

Closed
awaelchli opened this issue Jan 27, 2023 · 2 comments
Closed

Better name for Tuner methods #16529

awaelchli opened this issue Jan 27, 2023 · 2 comments
Labels
design Includes a design discussion discussion In a discussion stage tuner won't fix This will not be worked on

Comments

@awaelchli
Copy link
Contributor

awaelchli commented Jan 27, 2023

Description & Motivation

The PR #16462 introduced a breaking change with Lightning 2.0 that moves the auto_lr_find and auto_scale_batch_size features out of the Trainer:

trainer = Trainer()
tuner = Tuner(trainer)
tuner.lr_find(...)
tuner.scale_batch_size(...)

There is now an opportunity to also rename the methods, if we feel like there are better, more intuitive terms out there.

Pitch

Learning Rate tuner:

# current
tuner.lr_find()

# A
tuner.find_lr()

# B
tuner.find_learning_rate()

# C
(your suggestion in the comment)

Batch Size tuner:

# current
tuner.scale_batch_size()

# A (@Borda)
tuner.maximize_batch_size()

# B
tuner.find_batch_size()

# C
(your suggestion in the comment)

Alternatives

Keep as is :)

Additional context

No response

cc @Borda @tchaton @justusschock @awaelchli

@awaelchli awaelchli added needs triage Waiting to be triaged by maintainers discussion In a discussion stage design Includes a design discussion tuner and removed needs triage Waiting to be triaged by maintainers labels Jan 27, 2023
@stale
Copy link

stale bot commented Mar 19, 2023

This issue has been automatically marked as stale because it hasn't had any recent activity. This issue will be closed in 7 days if no further activity occurs. Thank you for your contributions - the Lightning Team!

@stale stale bot added the won't fix This will not be worked on label Mar 19, 2023
@stale stale bot closed this as completed Apr 16, 2023
@Borda
Copy link
Member

Borda commented Apr 17, 2023

Maybe sometime in the future...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
design Includes a design discussion discussion In a discussion stage tuner won't fix This will not be worked on
Projects
None yet
Development

No branches or pull requests

2 participants