Skip to content
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

Rename the TrainingTypePlugin base to Strategy #11120

Merged
merged 9 commits into from Dec 20, 2021

Conversation

awaelchli
Copy link
Member

@awaelchli awaelchli commented Dec 17, 2021

What does this PR do?

Renames the base class to Strategy.
The next PRs will cover all related usages:

Part of #10549

Before submitting

  • Was this discussed/approved via a GitHub issue? (not for typos and docs)
  • Did you read the contributor guideline, Pull Request section?
  • Did you make sure your PR does only one thing, instead of bundling different changes together?
  • Did you make sure to update the documentation with your changes? (if necessary)
  • Did you write any new necessary tests? (not for typos and docs)
  • Did you verify new and existing tests pass locally with your changes?
  • Did you update the CHANGELOG? (not for typos, docs, test updates, or internal minor changes/refactorings)

PR review

Anyone in the community is free to review the PR once the tests have passed.
Before you start reviewing make sure you have read Review guidelines. In short, see the following bullet-list:

  • Is this pull request ready for review? (if not, please submit in draft mode)
  • Check that all items from Before submitting are resolved
  • Make sure the title is self-explanatory and the description concisely explains the PR
  • Add labels and milestones (and optionally projects) to the PR so it can be classified

Did you have fun?

I made sure I had fun coding 🙃

Part of #1 (it's a lie, this is just here to avoid noisy GitHub bot)

cc @Borda @justusschock @awaelchli @akihironitta

@github-actions
Copy link
Contributor

Build Error! No Linked Issue found. Please link an issue or mention it in the body using #<issue_id>

@mergify mergify bot added the ready PRs ready to be merged label Dec 17, 2021
Co-authored-by: Rohit Gupta <rohitgr1998@gmail.com>
@four4fish four4fish added the breaking change Includes a breaking change label Dec 17, 2021
@mergify mergify bot removed the has conflicts label Dec 17, 2021
@four4fish
Copy link
Contributor

I marked this as breaking change as user who extend TrainingTypePlugin will need to update their class inheritance

Copy link
Contributor

@tchaton tchaton left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM !

Copy link
Contributor

@kaushikb11 kaushikb11 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a heavy breaking change on the import level itself for users who extend TrainingTypePlugin. Can’t we prevent it by introducing strategy.py file in the PR?

@mergify mergify bot removed the ready PRs ready to be merged label Dec 20, 2021
@justusschock
Copy link
Member

@kaushikb11 But then we only delay the breaking changes. I think we could introduce a training_type_plugin file for BC, but I really think we should go with these changes as they were considered to be experimental. And since we want to have it stable for 1.6, we cannot delay the BC beyond this

@awaelchli
Copy link
Member Author

@kaushikb11 To prevent a huge PR, I would prefer to go step by step by renaming parts individually. Once we move the files we can still add a simple reroute/deprecation path for mapping the training_type module to strategy

@kaushikb11 kaushikb11 self-requested a review December 20, 2021 11:52
@mergify mergify bot added the ready PRs ready to be merged label Dec 20, 2021
@awaelchli awaelchli merged commit 29eb9cc into master Dec 20, 2021
@awaelchli awaelchli deleted the refactor/strategy/rename-base branch December 20, 2021 12:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking change Includes a breaking change ready PRs ready to be merged refactor strategy
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

8 participants