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

Drop _stacklevel from argspecs of F.softmax, F.softmin, F.log_softmax (for implicit dim has been long deprecated) #36524

Open
vadimkantorov opened this issue Apr 13, 2020 · 4 comments
Labels
module: docs Related to our documentation, both in docs/ and docblocks triaged This issue has been looked at a team member, and triaged and prioritized into an appropriate module

Comments

@vadimkantorov
Copy link
Contributor

vadimkantorov commented Apr 13, 2020

https://pytorch.org/docs/master/nn.functional.html?highlight=softmax#torch.nn.functional.softmax

If it's unused or has some special undocumented meaning, I think it's useful to explain it explicitly in Parameters section

@vadimkantorov vadimkantorov changed the title [docs] F.softmax _stacklevel in argspec, but not described in Parameters section [docs] F.softmax: _stacklevel in argspec, but not described in Parameters section Apr 13, 2020
@vadimkantorov vadimkantorov changed the title [docs] F.softmax: _stacklevel in argspec, but not described in Parameters section [docs] F.softmax, F.softmin, F.log_softmax: _stacklevel in argspec, but not described in Parameters section Apr 13, 2020
@mrshenli mrshenli added module: docs Related to our documentation, both in docs/ and docblocks topic: operator triaged This issue has been looked at a team member, and triaged and prioritized into an appropriate module labels Apr 14, 2020
@vadimkantorov
Copy link
Contributor Author

I think this is related to the warning produced when dim is not unspecified. If that warning / unspecified dim behavior is killed, this _stacklevel mysterious arg also can go

@asanakoy
Copy link
Contributor

what is _stacklevel by the way?

@vadimkantorov
Copy link
Contributor Author

vadimkantorov commented Oct 25, 2020

It is somehow related to Python's warning suppression mechanism. If the legacy softmax dim behavior is gone, _stacklevel is not needed either

@vadimkantorov vadimkantorov changed the title [docs] F.softmax, F.softmin, F.log_softmax: _stacklevel in argspec, but not described in Parameters section Drop _stacklevel from argspecs of F.softmax, F.softmin, F.log_softmax (for implicit dim has been long deprecated) Oct 8, 2021
@vadimkantorov
Copy link
Contributor Author

I think implicit dim and _stacklevel should be dropped, because they have been deprecated long ago

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
module: docs Related to our documentation, both in docs/ and docblocks triaged This issue has been looked at a team member, and triaged and prioritized into an appropriate module
Projects
None yet
Development

No branches or pull requests

4 participants