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

make plugin type check more flexible #20186

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

jedyang97
Copy link

@jedyang97 jedyang97 commented Aug 10, 2024

What does this PR do?

The current type check of plugins for Trainer is restricted to list by isinstance(plugins, list). However, if plugins is instantiated from something like Hydra or OmegaConf, it will have type <class 'omegaconf.listconfig.ListConfig'>, and the current logic would wrap that list-like object with a second-layer list and cause subsequant logic to fail. If you look at the code, it is not necessary that plugins must be a list - it suffices as long as it is iterable. Therefore, the proposed simple fix change the check from isinstance(plugins, list) to isinstance(plugins, Iterable). I hope this can benefit those who uses Hydra or OmegaConf.

Before submitting
  • Was this discussed/agreed 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 list all the breaking changes introduced by this pull request?
  • Did you update the CHANGELOG? (not for typos, docs, test updates, or minor internal changes/refactors)

PR review

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

Reviewer checklist
  • 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

📚 Documentation preview 📚: https://pytorch-lightning--20186.org.readthedocs.build/en/20186/

@github-actions github-actions bot added the pl Generic label for PyTorch Lightning package label Aug 10, 2024
@jedyang97
Copy link
Author

Ah, I just realized that one can pass in _convert_: partial in OmegaConf to avoid casting the type to <class 'omegaconf.listconfig.ListConfig'>. In this case, I will leave it to the authors to decide whether this change is still worth it.

@@ -182,7 +183,7 @@ def _check_config_and_set_final_flags(

"""
if plugins is not None:
plugins = [plugins] if not isinstance(plugins, list) else plugins
plugins = [plugins] if not isinstance(plugins, Iterable) else plugins
Copy link
Contributor

Choose a reason for hiding this comment

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

@jedyang97 I'm ok with it either way. However, if this PR should land then we would want to update the type in the signature. And apply the same changes to fabric/connector.py as well.

On the other hand, we have arguments in other places where the user can pass in a list or tuple of elements, and nothing would prevent it to be a general Iterable but we still prefer to advertise the simple types just because of simplicity so it's clear to the user what they can pass in.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pl Generic label for PyTorch Lightning package
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants