Skip to content

Allow training_step in manual optimization to return general mappings #21011

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

Conversation

SkafteNicki
Copy link
Contributor

@SkafteNicki SkafteNicki commented Jul 28, 2025

What does this PR do?

Fixes #20993
Allows users doing manual optimization to return general mappings, including TensorDict as requested in the issue.
This also makes the supported output types consistent between manual and automatic optimization:

if isinstance(training_step_output, Mapping):

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--21011.org.readthedocs.build/en/21011/

@github-actions github-actions bot added the pl Generic label for PyTorch Lightning package label Jul 28, 2025
@deependujha deependujha merged commit 791753b into Lightning-AI:master Aug 6, 2025
85 checks passed
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.

Accept TensorDict (or more generally, dict-like's) as a training_step return type
4 participants