Extend collate function that can register collate functions to handle specific types by ejguan · Pull Request #85748 · pytorch/pytorch

ejguan · 2022-09-27T20:00:56Z

As per request from Vision team, adding collate function with an extra argument of collate_fn_map to dispatch custom collate functions for non-collection objects and specific objects.
If the type of batch element is not present incollate_fn_map, it will go through all keys in the insertion order to check if the type is a subclass of the key. If so, it will invoke the corresponding collate functions.

And, default_collate will utilize the collate function with a few by default collate function for int, float, str and numpy object.

Benefit:

Domain teams can register their own collate function to handle their specific type of objects
Easier for users to extend from the collate function.

pytorch-bot · 2022-09-27T20:00:59Z

🔗 Helpful Links

🧪 See artifacts and rendered test results at hud.pytorch.org/pr/85748

📄 Preview Python docs built from this PR
📄 Preview C++ docs built from this PR
❓ Need help or want to give feedback on the CI? Visit our office hours

Note: Links to docs will display an error until the docs builds have been completed.

✅ No Failures, 20 Pending

As of commit aa1a84d:
💚 Looks good so far! There are no failures yet. 💚

This comment was automatically generated by Dr. CI and updates every 15 minutes.

NivekT

Thanks for adding this. Overall, this makes sense to me. I think we should make it clear to users about how they can extend collate and default_collate (provide examples) and what the best practices may be.

For example:

They can write their own collate_fn_map and create their own collate function with that
They can write their own collate function that imports and uses default_collate?

torch/utils/data/_utils/collate.py

pmeier

Thanks Erjia! I left a few inline comments.

torch/utils/data/_utils/collate.py

NivekT

LGTM! Thanks for making the changes. A small comment but feel free to ignore.

We should import and render the documentation for these functions in TorchData (or in core documentation) for the upcoming release.

torch/utils/data/_utils/collate.py

ejguan · 2022-09-28T20:07:12Z

We should import and render the documentation for these functions in TorchData (or in core documentation) for the upcoming release.

Let me see how to add it to PyTorch Core doc.

pmeier

LGTM when the documentation issue is sorted out and CI is green. Thanks Erjia!

torch/utils/data/_utils/collate.py

ejguan · 2022-09-29T17:49:58Z

@pytorchbot rebase

pytorchmergebot · 2022-09-29T17:51:32Z

@pytorchbot successfully started a rebase job. Check the current status here

pytorchmergebot · 2022-09-29T17:51:35Z

Successfully rebased extend_collate onto refs/remotes/origin/viable/strict, please pull locally before adding more changes (for example, via git checkout extend_collate && git pull --rebase)

ejguan · 2022-09-29T17:55:40Z

@pytorchbot merge -g

pytorchmergebot · 2022-09-29T17:57:14Z

@pytorchbot successfully started a merge job. Check the current status here.
The merge job was triggered with the green (-g) flag. This means that your change will be merged once all checks on your PR have passed (ETA: 0-4 Hours). If this is not the intended behavior, feel free to use some of the other merge options in the wiki.
Please reach out to the PyTorch DevX Team with feedback or questions!

pytorchmergebot · 2022-09-29T18:12:22Z

Merge failed

Reason: The following mandatory check(s) failed (Rule superuser):

pull

Dig deeper by viewing the failures on hud

Details for Dev Infra team

Raised by workflow job

ejguan · 2022-09-29T18:34:48Z

@pytorchbot rebase -m

pytorch-bot · 2022-09-29T18:34:50Z

❌ 🤖 pytorchbot command failed:

@pytorchbot: error: unrecognized arguments: -m

usage: @pytorchbot [-h] {merge,revert,rebase,label} ...

Try @pytorchbot --help for more info.

ejguan · 2022-09-29T18:40:07Z

@pytorchbot rebase -b master

pytorchmergebot · 2022-09-29T18:41:39Z

@pytorchbot successfully started a rebase job. Check the current status here

pytorchmergebot · 2022-09-29T18:41:42Z

Successfully rebased extend_collate onto refs/remotes/origin/master, please pull locally before adding more changes (for example, via git checkout extend_collate && git pull --rebase)

ejguan · 2022-09-29T19:47:53Z

@pytorchbot merge -g

pytorchmergebot · 2022-09-29T19:49:17Z

@pytorchbot successfully started a merge job. Check the current status here.
The merge job was triggered with the green (-g) flag. This means that your change will be merged once all checks on your PR have passed (ETA: 0-4 Hours). If this is not the intended behavior, feel free to use some of the other merge options in the wiki.
Please reach out to the PyTorch DevX Team with feedback or questions!

pytorchmergebot · 2022-09-29T19:54:23Z

Merge failed

Reason: The following mandatory check(s) failed (Rule superuser):

pull

Dig deeper by viewing the failures on hud

Details for Dev Infra team

Raised by workflow job

ejguan · 2022-09-29T20:49:56Z

Have to manually rebase onto the safest commits on master due to the broken viable/strict branch.

facebook-github-bot · 2022-09-29T20:50:15Z

@ejguan has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator.

ejguan · 2022-09-29T22:47:15Z

@pytorchbot merge -g

pytorchmergebot · 2022-09-29T22:50:29Z

@pytorchbot successfully started a merge job. Check the current status here.
The merge job was triggered with the green (-g) flag. This means that your change will be merged once all checks on your PR have passed (ETA: 0-4 Hours). If this is not the intended behavior, feel free to use some of the other merge options in the wiki.
Please reach out to the PyTorch DevX Team with feedback or questions!

pytorchmergebot · 2022-09-29T22:50:33Z

Merge failed

Reason: The following mandatory check(s) failed (Rule superuser):

pull

Dig deeper by viewing the failures on hud

Details for Dev Infra team

Raised by workflow job

ejguan · 2022-09-30T00:51:53Z

@pytorchbot rebase

pytorchmergebot · 2022-09-30T00:53:25Z

@pytorchbot successfully started a rebase job. Check the current status here

… specific types

pytorchmergebot · 2022-09-30T00:53:28Z

Successfully rebased extend_collate onto refs/remotes/origin/viable/strict, please pull locally before adding more changes (for example, via git checkout extend_collate && git pull --rebase)

ejguan · 2022-09-30T02:54:04Z

@pytorchbot merge -g

pytorchmergebot · 2022-09-30T02:55:47Z

@pytorchbot successfully started a merge job. Check the current status here.
The merge job was triggered with the green (-g) flag. This means that your change will be merged once all checks on your PR have passed (ETA: 0-4 Hours). If this is not the intended behavior, feel free to use some of the other merge options in the wiki.
Please reach out to the PyTorch DevX Team with feedback or questions!

pytorchmergebot · 2022-09-30T03:00:53Z

Merge failed

Reason: 1 additional jobs have failed, first few of them are: Meta Internal-Only Changes Check

Details for Dev Infra team

Raised by workflow job

ejguan · 2022-09-30T13:28:51Z

@pytorchbot merge -f "The internal signal is cyclic referenced to OSS failure on a previous commit"

pytorchmergebot · 2022-09-30T13:30:13Z

@pytorchbot successfully started a merge job. Check the current status here.
The merge job was triggered with the force (-f) flag. This means your change will be merged immediately, bypassing any CI checks (ETA: 1-5 minutes). If this is not the intended behavior, feel free to use some of the other merge options in the wiki.
Please reach out to the PyTorch DevX Team with feedback or questions!

… specific types (#85748) As per request from Vision team, adding `collate` function with an extra argument of `collate_fn_map` to dispatch custom collate functions for non-collection objects and specific objects. If the type of batch element is not present in`collate_fn_map`, it will go through all keys in the insertion order to check if the type is a subclass of the key. If so, it will invoke the corresponding collate functions. And, `default_collate` will utilize the `collate` function with a few by default collate function for `int`, `float`, `str` and `numpy object`. Benefit: - Domain teams can register their own `collate` function to handle their specific type of objects - Easier for users to extend from the `collate` function. Pull Request resolved: #85748 Approved by: https://github.com/NivekT, https://github.com/pmeier

ejguan requested a review from pmeier September 27, 2022 20:00

pytorch-bot bot added the release notes: dataloader release notes category label Sep 27, 2022

facebook-github-bot added the cla signed label Sep 27, 2022

ejguan added the topic: improvements topic category label Sep 27, 2022

ejguan requested review from NivekT and VitalyFedyunin September 27, 2022 20:03

NivekT reviewed Sep 27, 2022

View reviewed changes

torch/utils/data/_utils/collate.py Outdated Show resolved Hide resolved

torch/utils/data/_utils/collate.py Outdated Show resolved Hide resolved

torch/utils/data/_utils/collate.py Show resolved Hide resolved

pmeier reviewed Sep 28, 2022

View reviewed changes

ejguan requested review from NivekT and pmeier September 28, 2022 16:27

NivekT approved these changes Sep 28, 2022

View reviewed changes

torch/utils/data/_utils/collate.py Show resolved Hide resolved

pytorch-bot bot added the ciflow/trunk Trigger trunk jobs on your pull request label Sep 28, 2022

pmeier approved these changes Sep 29, 2022

View reviewed changes

torch/utils/data/_utils/collate.py Show resolved Hide resolved

ejguan force-pushed the extend_collate branch from 6bcd6e7 to ae805b6 Compare September 29, 2022 14:46

pytorchmergebot force-pushed the extend_collate branch from 2221ac2 to c65ca5c Compare September 29, 2022 17:51

pytorchmergebot force-pushed the extend_collate branch from c65ca5c to 52b159a Compare September 29, 2022 18:41

ejguan force-pushed the extend_collate branch from 52b159a to e2d20ca Compare September 29, 2022 20:49

ejguan added 6 commits September 30, 2022 00:53

Extend collate function that can register collate functions to handle…

029a271

… specific types

Update per comment

109c458

Add collate to pytorch doc

c37b4a2

Add examples to extend default_collate

63d5ef5

Fix lint

f583be1

Fix doc

aa1a84d

pytorchmergebot force-pushed the extend_collate branch from e2d20ca to aa1a84d Compare September 30, 2022 00:53

pytorchmergebot added the Merged label Sep 30, 2022

pytorchmergebot closed this in b13b10a Sep 30, 2022

wyli mentioned this pull request Jan 31, 2023

simplify list_data_collate and collate_meta_tensor using collate Project-MONAI/MONAI#5917

Closed

KumoLiu mentioned this pull request Oct 26, 2023

simplify list_data_collate and collate_meta_tensor Project-MONAI/MONAI#7165

Merged

7 tasks

Conversation

ejguan commented Sep 27, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pytorch-bot bot commented Sep 27, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🔗 Helpful Links

🧪 See artifacts and rendered test results at hud.pytorch.org/pr/85748

✅ No Failures, 20 Pending

Uh oh!

NivekT left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

pmeier left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

NivekT left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ejguan commented Sep 28, 2022

Uh oh!

pmeier left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ejguan commented Sep 29, 2022

Uh oh!

pytorchmergebot commented Sep 29, 2022

Uh oh!

pytorchmergebot commented Sep 29, 2022

Uh oh!

ejguan commented Sep 29, 2022

Uh oh!

pytorchmergebot commented Sep 29, 2022

Uh oh!

pytorchmergebot commented Sep 29, 2022

Merge failed

Uh oh!

ejguan commented Sep 29, 2022

Uh oh!

pytorch-bot bot commented Sep 29, 2022

Uh oh!

ejguan commented Sep 29, 2022

Uh oh!

pytorchmergebot commented Sep 29, 2022

Uh oh!

pytorchmergebot commented Sep 29, 2022

Uh oh!

ejguan commented Sep 29, 2022

Uh oh!

pytorchmergebot commented Sep 29, 2022

Uh oh!

pytorchmergebot commented Sep 29, 2022

Merge failed

Uh oh!

ejguan commented Sep 29, 2022

Uh oh!

facebook-github-bot commented Sep 29, 2022

Uh oh!

ejguan commented Sep 29, 2022

Uh oh!

pytorchmergebot commented Sep 29, 2022

Uh oh!

pytorchmergebot commented Sep 29, 2022

Merge failed

Uh oh!

ejguan commented Sep 30, 2022

Uh oh!

pytorchmergebot commented Sep 30, 2022

Uh oh!

ejguan commented Sep 27, 2022 •

edited

Loading

pytorch-bot bot commented Sep 27, 2022 •

edited

Loading