-
Notifications
You must be signed in to change notification settings - Fork 26.3k
Extend explanation of torch.cholesky_inverse to consider batched inputs.
#69069
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
Extend explanation of torch.cholesky_inverse to consider batched inputs.
#69069
Conversation
CI Flow Status⚛️ CI FlowRuleset - Version:
You can add a comment to the PR and tag @pytorchbot with the following commands: # ciflow rerun, "ciflow/default" will always be added automatically
@pytorchbot ciflow rerun
# ciflow rerun with additional labels "-l <ciflow/label_name>", which is equivalent to adding these labels manually and trigger the rerun
@pytorchbot ciflow rerun -l ciflow/scheduled -l ciflow/slowFor more information, please take a look at the CI Flow Wiki. |
🔗 Helpful links
💊 CI failures summary and remediationsAs of commit aa3ceb8 (more details on the Dr. CI page): 💚 💚 Looks good so far! There are no failures yet. 💚 💚 This comment was automatically generated by Dr. CI (expand for details).Please report bugs/suggestions to the (internal) Dr. CI Users group. |
torch.cholesky_inverse
torch.cholesky_inversetorch.cholesky_inverse to consider batched inputs.
torch/_torch_docs.py
Outdated
| [-0.0889, 0.2122, 0.1412]]) | ||
| >>> a = torch.randn(3, 2, 2) | ||
| >>> a = a @ a.mT + 1e-03 # make symmetric positive-definite | ||
| >>> l = torch.cholesky(a) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's update this to use the non-deprecate linalg operators (so linalg.cholesky here and above and linalg.inv instead of inverse)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for checking. I reflected it.
@mruberry Is it possible that functions like torch.cholesky_inverse will be deprecated in near future?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We intend to port all the linear algebra functions to torch.linalg, so I'd say yes. Now, "the near future" might very well span from 6 months to a full year.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's great! I hope to contribute in the process if I can afford to do so at that time. :)
For now, I will just revise the docs.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: Seems like this isn't updated to torch.linalg.cholesky yet.
|
Hey @nonconvexopt! Thanks for taking the time to help update the documentation for |
…:nonconvexopt/pytorch into finish_doc_update_about_cholesky_inverse
neerajprad
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just some small comments. LGTM pending @mruberry's comments.
torch/_torch_docs.py
Outdated
| [-0.0889, 0.2122, 0.1412]]) | ||
| >>> a = torch.randn(3, 2, 2) | ||
| >>> a = a @ a.mT + 1e-03 # make symmetric positive-definite | ||
| >>> l = torch.cholesky(a) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: Seems like this isn't updated to torch.linalg.cholesky yet.
…:nonconvexopt/pytorch into finish_doc_update_about_cholesky_inverse
|
@mruberry - does this look good to you? |
mruberry
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good; one small nit about preserving the torch.cholesky example calling torch.cholesky (instead of torch.linalg.cholesky)
|
@neerajprad has imported this pull request. If you are a Facebook employee, you can view this diff on Phabricator. |
…puts. (#69069) Summary: While implementing #68720, We found out empirically that `torch.cholesky_inverse` support batched inputs, but it is not explained in doc: [link](#68720 (review)) `torch.cholesky_inverse` is implemented in #50269 and the doc was updated at #31275 but not merged. neerajprad Reviewed By: mrshenli Differential Revision: D32979362 Pulled By: neerajprad fbshipit-source-id: 0967c969434ce6e0ab15889c240149c23c0bce44 [ghstack-poisoned]
…puts. (#69069) Summary: While implementing #68720, We found out empirically that `torch.cholesky_inverse` support batched inputs, but it is not explained in doc: [link](#68720 (review)) `torch.cholesky_inverse` is implemented in #50269 and the doc was updated at #31275 but not merged. neerajprad Reviewed By: mrshenli Differential Revision: D32979362 Pulled By: neerajprad fbshipit-source-id: 0967c969434ce6e0ab15889c240149c23c0bce44
…puts. (#69069) Summary: While implementing #68720, We found out empirically that `torch.cholesky_inverse` support batched inputs, but it is not explained in doc: [link](#68720 (review)) `torch.cholesky_inverse` is implemented in #50269 and the doc was updated at #31275 but not merged. neerajprad Pull Request resolved: #69069 Reviewed By: mrshenli Differential Revision: D32979362 Pulled By: neerajprad fbshipit-source-id: 0967c969434ce6e0ab15889c240149c23c0bce44
…puts. (#69069) Summary: While implementing #68720, We found out empirically that `torch.cholesky_inverse` support batched inputs, but it is not explained in doc: [link](#68720 (review)) `torch.cholesky_inverse` is implemented in #50269 and the doc was updated at #31275 but not merged. neerajprad Pull Request resolved: #69069 Reviewed By: mrshenli Differential Revision: D32979362 Pulled By: neerajprad fbshipit-source-id: 0967c969434ce6e0ab15889c240149c23c0bce44
While implementing #68720,
We found out empirically that
torch.cholesky_inversesupport batched inputs, but it is not explained in doc: linktorch.cholesky_inverseis implemented in #50269 and the doc was updated at #31275 but not merged.@neerajprad