update torch.eig() doc #10315
update torch.eig() doc #10315
Conversation
ailzhang
requested review from
apaszke,
colesbury,
ezyang,
gchanan,
soumith and
zdevito
as code owners
facebook-github-bot
left a comment
facebook-github-bot
left a comment
There was a problem hiding this comment.
ailzhang has imported this pull request. If you are a Facebook employee, you can view this diff on Phabricator.
torch/_torch_docs.py
Outdated
| - **e** (*Tensor*): the right eigenvalues of ``a`` | ||
| - **v** (*Tensor*): the eigenvectors of ``a`` if ``eigenvectors`` is ``True``; otherwise an empty tensor | ||
| - **e** (*Tensor*): Shape :math:`(n \times 2)`. Each row is an eigenvalue of ``a``, | ||
| with the first element is the real part and the second element is the imanginary part. |
This comment was marked as off-topic.
This comment was marked as off-topic.
Sorry, something went wrong.
This comment was marked as off-topic.
This comment was marked as off-topic.
Sorry, something went wrong.
torch/_torch_docs.py
Outdated
| with the first element is the real part and the second element is the imanginary part. | ||
| The eigenvalues are not necessarily ordered. | ||
| - **v** (*Tensor*): If ``eigenvectors=False``, it's an empty tensor. | ||
| Otherwise this tensor of shape :math:`(n \times n)`, contains normalized (unit “length”) eigenvector info, |
This comment was marked as off-topic.
This comment was marked as off-topic.
Sorry, something went wrong.
This comment was marked as off-topic.
This comment was marked as off-topic.
Sorry, something went wrong.
This comment was marked as off-topic.
This comment was marked as off-topic.
Sorry, something went wrong.
This comment was marked as off-topic.
This comment was marked as off-topic.
Sorry, something went wrong.
| If the corresponding e[j] is a real number, column v[:, j] is the eigenvector corresponding to | ||
| eigenvalue e[j]. | ||
| If the corresponding e[j] and e[j + 1] eigenvalues form a complex conjugate pair, then the true | ||
| :math:`eigenvector[j] = v[:, j] + i * v[:, j + 1], eigenvector[j + 1] = v[:, j] - i * v[:, j + 1]`. |
This comment was marked as off-topic.
This comment was marked as off-topic.
Sorry, something went wrong.
|
@ezyang Looks better now? :) |
facebook-github-bot
left a comment
facebook-github-bot
left a comment
There was a problem hiding this comment.
ailzhang has imported this pull request. If you are a Facebook employee, you can view this diff on Phabricator.
Summary: This fixes pytorch#9383 Update torch.eig() doc, the complex part is written based on https://scc.ustc.edu.cn/zlsc/sugon/intel/mkl/mkl_manual/GUID-16EB5901-5644-4DA6-A332-A052309010C4.htm Pull Request resolved: pytorch#10315 Reviewed By: yf225 Differential Revision: D9200723 Pulled By: ailzhang fbshipit-source-id: d2e186fd24defbc4fdea6c2cf3dc4f7e05e1d170
Summary: This fixes pytorch#9383 Update torch.eig() doc, the complex part is written based on https://scc.ustc.edu.cn/zlsc/sugon/intel/mkl/mkl_manual/GUID-16EB5901-5644-4DA6-A332-A052309010C4.htm Pull Request resolved: pytorch#10315 Reviewed By: yf225 Differential Revision: D9200723 Pulled By: ailzhang fbshipit-source-id: d2e186fd24defbc4fdea6c2cf3dc4f7e05e1d170
3 participants
This fixes #9383
Update torch.eig() doc, the complex part is written based on https://scc.ustc.edu.cn/zlsc/sugon/intel/mkl/mkl_manual/GUID-16EB5901-5644-4DA6-A332-A052309010C4.htm