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

Including generator param in randperm documentation #47231

Closed
wants to merge 2 commits into from

Conversation

janeyx99
Copy link
Contributor

@janeyx99 janeyx99 commented Nov 2, 2020

The randperm documentation is outdated and did not use to include the optional generator parameter. This PR just adds that along with the pin_memory parameter.

This PR was brought up in PR 47022, but is now rebased onto master.

New docs look like:
image

Copy link
Contributor

@walterddr walterddr left a comment

Choose a reason for hiding this comment

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

thanks for the follow up. :-) - we definitely need better linter @samestep

torch/_torch_docs.py Outdated Show resolved Hide resolved
@janeyx99
Copy link
Contributor Author

janeyx99 commented Nov 2, 2020

@mruberry I couldn't seem to find where there's duplication. I think the double search result is because it is in both Python docs and mentioned in C++ docs, but my understanding of the documentation is not very deep.

@dr-ci
Copy link

dr-ci bot commented Nov 2, 2020

💊 CI failures summary and remediations

As of commit 3b0bf43 (more details on the Dr. CI page):


💚 💚 Looks good so far! There are no failures yet. 💚 💚


1 failure confirmed as flaky and can be ignored:

  • pytorch_linux_xenial_cuda9_2_cudnn7_py3_gcc5_4_build

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 on the GitHub issue tracker or post in the (internal) Dr. CI Users group.

See how this bot performed.

This comment has been revised 13 times.

@mruberry
Copy link
Collaborator

mruberry commented Nov 2, 2020

Thanks @janeyx99!

torch/_torch_docs.py Outdated Show resolved Hide resolved
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.

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

@codecov
Copy link

codecov bot commented Nov 4, 2020

Codecov Report

Merging #47231 into master will increase coverage by 0.00%.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master   #47231   +/-   ##
=======================================
  Coverage   60.81%   60.81%           
=======================================
  Files        2748     2748           
  Lines      254047   254047           
=======================================
+ Hits       154503   154505    +2     
+ Misses      99544    99542    -2     

@facebook-github-bot
Copy link
Contributor

@janeyx99 merged this pull request in 01da0fe.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants