Skip to content

make the loss context manager easier to extend #39321

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

Merged
merged 1 commit into from
Jul 16, 2025

Conversation

winglian
Copy link
Contributor

@winglian winglian commented Jul 9, 2025

What does this PR do?

Using ExitStack makes it easier to extend the functionality of the context manager wrapping the model(inputs) call. This can make it easier to add other things like logging contexts, checkpointing contexts, etc down the road.

e.g.

class CustomTrainer(Trainer):
    def compute_loss_context_manager(self):
        ctx_stack = super(). compute_loss_context_manager()
        my_custom_ctx = CustomContext(...)
        ctx_stack.enter_context(my_custom_ctx)
        return ctx_stack

Fixes # (issue)

Before submitting

  • This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case).
  • Did you read the contributor guideline,
    Pull Request section?
  • Was this discussed/approved via a Github issue or the forum? Please add a link
    to it if that's the case.
  • Did you make sure to update the documentation with your changes? Here are the
    documentation guidelines, and
    here are tips on formatting docstrings.
  • Did you write any new necessary tests?

Who can review?

@SunMarc @ArthurZucker
Anyone in the community is free to review the PR once the tests have passed. Feel free to tag
members/contributors who may be interested in your PR.

Copy link
Member

@SunMarc SunMarc left a comment

Choose a reason for hiding this comment

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

Thanks !

Comment on lines +3698 to +3704
ctx_stack = contextlib.ExitStack()

autocast_ctx = self.autocast_smart_context_manager()
if not isinstance(autocast_ctx, contextlib.nullcontext):
ctx_stack.enter_context(autocast_ctx)

return ctx_stack
Copy link
Member

Choose a reason for hiding this comment

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

nice ! maybe add in the doctstring that users can easily extend the context manager also !

@HuggingFaceDocBuilderDev

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update.

Copy link
Collaborator

@ArthurZucker ArthurZucker left a comment

Choose a reason for hiding this comment

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

+1 on documenting and thanks!

@SunMarc SunMarc merged commit ba506f8 into huggingface:main Jul 16, 2025
25 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants