Improve documentation for torch.lobpcg #156139
Conversation
🔗 Helpful Links🧪 See artifacts and rendered test results at hud.pytorch.org/pr/156139
Note: Links to docs will display an error until the docs builds have been completed. ✅ You can merge normally! (1 Unrelated Failure)As of commit 040ace4 with merge base 4e8dd11 ( UNSTABLE - The following job is marked as unstable, possibly due to flakiness on trunk:
This comment was automatically generated by Dr. CI and updates every 15 minutes. |
colesbury
added
the
triaged
colesbury
changed the title
|
@pytorchbot label "topic: not user facing" |
|
/easyCLA |
|
/easycla |
torch/_lobpcg.py
Outdated
| we do the following symmetrization map: `A -> (A + A.t()) / 2`. | ||
| The map is performed only when the `A` requires gradients. | ||
| .. warning:: `m` must be bigger than 3 x the number of requested eigenpairs. |
There was a problem hiding this comment.
Could you change this to something like:
-> LPBPCG algorithm is not applicable when the number of A's rows is smaller than 3x the number of requested eigenpairs n
There was a problem hiding this comment.
Sure I will make this change and re generate the PR.
|
@pytorchbot merge |
soulitzer
added
release notes: python_frontend
Merge startedYour change will be merged once all checks pass (ETA 0-4 Hours). Learn more about merging in the wiki. Questions? Feedback? Please reach out to the PyTorch DevX Team |
|
Merge failedReason: 1 jobs have failed, first few of them are: trunk / macos-py3-arm64 / test (mps, 1, 1, macos-m2-15) Details for Dev Infra teamRaised by workflow job |
|
Hi @soulitzer , |
|
@pytorchbot rebase |
|
@pytorchbot started a rebase job onto refs/remotes/origin/viable/strict. Check the current status here |
The changes are documentation changes to the function lobpcg. There are three changes to the doc. 1. Match doc arg description to be in the same order as the parameters to the function. 2. Update documentation for arg `n` to indicate that when arg `x` is specified value of `n` is ignored if set. 3. Add warning that `m` must be bigger than 3 x the number of requested eigenpairs.
for parameter n and the new warning message.
in the previous commit. Also using :math: when referring the vector variable X
|
Successfully rebased |
pytorchmergebot
force-pushed
the
fix-for-doc-issue-152107
branch
from
a785ef7 to
a283e42
Compare
It should be enough to see the docs build pass, but it seems like the rendered docs link isn't being updated... |
@soulitzer thanks for re-basing, if there is anything else to be done from my side to make progress let me know. |
|
@pytorchbot merge -f "docs build passed" |
Merge startedYour change will be merged immediately since you used the force (-f) flag, bypassing any CI checks (ETA: 1-5 minutes). Please use Learn more about merging in the wiki. Questions? Feedback? Please reach out to the PyTorch DevX Team |
The changes are documentation changes to the function lobpcg. There are three changes to the doc. 1. Match doc arg description to be in the same order as the parameters to the function. 2. Update documentation for arg `n` to indicate that when arg `x` is specified value of `n` is ignored if set. 3. Add warning that `m` must be bigger than 3 x the number of requested eigenpairs. Fixes pytorch#152107 Pull Request resolved: pytorch#156139 Approved by: https://github.com/soulitzer
6 participants
The changes are documentation changes to the function lobpcg. There are three changes to the doc.
nto indicate that when argxis specified value ofnis ignored if set.mmust be bigger than 3 x the number of requested eigenpairs.Fixes #152107
cc: @ILCSFNO @spzala @soulitzer