Skip to content
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

[docs] add docstring in torch.cuda.get_device_properties #49792

Closed

Conversation

ydcjeff
Copy link
Contributor

@ydcjeff ydcjeff commented Dec 23, 2020

Fixes #49737

Added docstring in torch.cuda.get_device_properties
Added the Returns in torch.cuda.get_device_name

@facebook-github-bot
Copy link
Contributor

facebook-github-bot commented Dec 23, 2020

💊 CI failures summary and remediations

As of commit 0887d40 (more details on the Dr. CI page):


None of the CI failures appear to be your fault 💚



1 job timed out:

  • pytorch_linux_bionic_py3_8_gcc9_coverage_test1

🚧 1 fixed upstream failure:

These were probably caused by upstream breakages that were already fixed.

Please rebase on the viable/strict branch (expand for instructions)

If your commit is older than viable/strict, run these commands:

git fetch https://github.com/pytorch/pytorch viable/strict
git rebase FETCH_HEAD

Check out the recency history of this "viable master" tracking branch.


This comment was automatically generated by Dr. CI (expand for details).Follow this link to opt-out of these comments for your Pull Requests.

Please report bugs/suggestions to the (internal) Dr. CI Users group.

This comment has been revised 8 times.

@ydcjeff
Copy link
Contributor Author

ydcjeff commented Dec 23, 2020

I added the docstring similar to other get_device_*.
Let me know if it needs to be improved.

@ydcjeff
Copy link
Contributor Author

ydcjeff commented Dec 23, 2020

Just noticed the return types are missing after the function/class name (annotated with →) on the master docs.
That is present on stable docs.

@mruberry mruberry added module: cuda Related to torch.cuda, and CUDA support in general triaged This issue has been looked at a team member, and triaged and prioritized into an appropriate module labels Dec 29, 2020
@mruberry mruberry requested a review from ngimel December 29, 2020 17:53
torch/cuda/__init__.py Outdated Show resolved Hide resolved
Copy link
Collaborator

@ngimel ngimel left a comment

Choose a reason for hiding this comment

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

Looks good, please change Arguments to Args.

torch/cuda/__init__.py Outdated Show resolved Hide resolved
@ydcjeff
Copy link
Contributor Author

ydcjeff commented Jan 5, 2021

any updates to merge?

Copy link
Contributor

@facebook-github-bot facebook-github-bot left a comment

Choose a reason for hiding this comment

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

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

@facebook-github-bot
Copy link
Contributor

@ngimel merged this pull request in d1a56fc.

@ydcjeff ydcjeff deleted the docs/cuda.get_device_properties branch January 6, 2021 02:03
hwangdeyu pushed a commit to hwangdeyu/pytorch that referenced this pull request Jan 14, 2021
Summary:
Fixes pytorch#49737

Added docstring in `torch.cuda.get_device_properties`
Added the `Returns` in `torch.cuda.get_device_name`

Pull Request resolved: pytorch#49792

Reviewed By: mruberry

Differential Revision: D25784046

Pulled By: ngimel

fbshipit-source-id: f88da02147f92c889398957fcaf22961d3bb1062
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla signed Merged module: cuda Related to torch.cuda, and CUDA support in general open source triaged This issue has been looked at a team member, and triaged and prioritized into an appropriate module
Projects
None yet
Development

Successfully merging this pull request may close these issues.

torch.cuda.get_device_properties is missing in cuda docs
5 participants