Skip to content

Register ModelOutput class with PyTorch's pytree#25360

Closed
wconstab wants to merge 1 commit intohuggingface:mainfrom
wconstab:wconstab/pytree
Closed

Register ModelOutput class with PyTorch's pytree#25360
wconstab wants to merge 1 commit intohuggingface:mainfrom
wconstab:wconstab/pytree

Conversation

@wconstab
Copy link
Copy Markdown

@wconstab wconstab commented Aug 8, 2023

Summary:
PyTree lets users flatten arbitrarily complex py data structures (e.g. ModelOutput) and operate over a flat list of their constituent parts.

Users could opt to register HF's ModelOutput with pytree manually and then use it, but many users would not know to do this or would be inconvenienced by it.

A common use case is to operate over all the tensors in a model's output.

Test Plan:
I've added a unit test but haven't run it locally (yet as it depends on PT and TF) - would check if CI runs it first.

Reviewers:

Subscribers:

Tasks:

Tags:

What does this PR do?

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?

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.

Summary:
PyTree lets users flatten arbitrarily complex py data structures (e.g.
ModelOutput) and operate over a flat list of their constituent parts.

Users could opt to register HF's ModelOutput with pytree manually and
then use it, but many users would not know to do this or would be
inconvenienced by it.

A common use case is to operate over all the tensors in a model's
output.

Test Plan:
I've added a unit test but haven't run it locally (yet as it depends on
PT and TF) - would check if CI runs it first.

Reviewers:

Subscribers:

Tasks:

Tags:
@sgugger
Copy link
Copy Markdown
Collaborator

sgugger commented Aug 8, 2023

Was superseded by #25358 as discussed there.

@wconstab wconstab closed this Aug 8, 2023
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.

2 participants