Skip to content

Clarify meaning of pin_memory_device argument #94349

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.

Sign up for GitHub

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

Jump to bottom
Closed
wants to merge 2 commits into from
Closed

Clarify meaning of pin_memory_device argument #94349

wants to merge 2 commits into from

Conversation

klieret
Copy link
Contributor

@klieret klieret commented Feb 7, 2023

I don't think the docstring explaining pin_memory_device is very clear. If it weren't for the string type, I would not have guessed that this was about the device that is referred to in the pin_memory option (and honestly, it took me a few minutes before noticing the type).

@pytorch-bot
Copy link

pytorch-bot bot commented Feb 7, 2023 •
edited
Loading

🔗 Helpful Links

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

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

✅ No Failures

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

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

@pytorch-bot pytorch-bot bot added the release notes: dataloader release notes category label Feb 7, 2023
@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Feb 7, 2023 •
edited
Loading

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: klieret / name: Kilian Lieret (3d13add)

@soulitzer soulitzer requested review from NivekT and ejguan February 8, 2023 20:19
@soulitzer soulitzer added the triaged This issue has been looked at a team member, and triaged and prioritized into an appropriate module label Feb 8, 2023
ejguan
ejguan approved these changes Feb 8, 2023
View reviewed changes
Copy link
Contributor

@ejguan ejguan left a comment

Choose a reason for hiding this comment

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

LGTM

NivekT
NivekT reviewed Feb 8, 2023
View reviewed changes
Copy link
Contributor

@NivekT NivekT left a comment

Choose a reason for hiding this comment

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

Hi, thanks for opening this PR. I think it looks good and can be merged after the linting is fixed.

@klieret
Copy link
Contributor Author

klieret commented Feb 8, 2023

(whitespace should be fixed now)

@ejguan ejguan added the topic: docs topic category label Feb 8, 2023
@ejguan
Copy link
Contributor

ejguan commented Feb 15, 2023

@pytorchbot rebase

@pytorchmergebot
Copy link
Collaborator

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

@pytorchmergebot
Copy link
Collaborator

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

@pytorchmergebot pytorchmergebot force-pushed the update-pin-memory-device-docstring branch from 7c02779 to 2aa0820 Compare February 15, 2023 20:20
@ejguan
Copy link
Contributor

ejguan commented Feb 15, 2023 •
edited
Loading

@pytorchbot merge -f "PR only touches inline doc and all linters pass"

@pytorchmergebot
Copy link
Collaborator

Merge started

Your change will be merged immediately since you used the force (-f) flag, bypassing any CI checks (ETA: 1-5 minutes).

Learn more about merging in the wiki.

Questions? Feedback? Please reach out to the PyTorch DevX Team

Advanced Debugging
Check the merge workflow status
here

@klieret
Copy link
Contributor Author

klieret commented Feb 15, 2023

Thanks @ejguan !

@msaroufim msaroufim mentioned this pull request Mar 3, 2023
Closed
pruthvistony added a commit to ROCm/pytorch that referenced this pull request May 2, 2023
@pruthvistony
Revert "Clarify meaning of pin_memory_device argument (pytorch#94349)"
6e3439d 
This reverts commit 66bea59.
jhavukainen pushed a commit to kulinseth/pytorch that referenced this pull request Mar 15, 2024
@klieret @jhavukainen
Clarify meaning of pin_memory_device argument (pytorch#94349)
0596876 
I don't think the docstring explaining `pin_memory_device` is very clear. If it weren't for the string type, I would not have guessed that this was about the device that is referred to in the `pin_memory` option (and honestly, it took me a few minutes before noticing the type).
Pull Request resolved: pytorch#94349
Approved by: https://github.com/ejguan
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ejguan ejguan ejguan approved these changes

+1 more reviewer

@NivekT NivekT NivekT left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

Merged open source release notes: dataloader release notes category topic: docs topic category triaged This issue has been looked at a team member, and triaged and prioritized into an appropriate module

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@klieret @ejguan @pytorchmergebot @NivekT @soulitzer @pytorchbot