export XPUStream to doc #121398
export XPUStream to doc #121398
Conversation
🔗 Helpful Links🧪 See artifacts and rendered test results at hud.pytorch.org/pr/121398
Note: Links to docs will display an error until the docs builds have been completed. ✅ No FailuresAs of commit 6be86ea with merge base 10bdf64 ( This comment was automatically generated by Dr. CI and updates every 15 minutes. |
guangyey
added
ciflow/xpu
[ghstack-poisoned]
albanD
left a comment
albanD
left a comment
There was a problem hiding this comment.
That sounds fine. I would say that we have very very few users of our c++ API.
I don't see this on the rendered doc: https://docs-preview.pytorch.org/pytorch/pytorch/121398/cppdocs/search.html?q=xpustream&check_keywords=yes&area=default (you can find this link in the drci comment)
I think |
@albanD PyTorch has some C++ users, perhaps they are not very active in online community. :) |
jgong5
left a comment
jgong5
left a comment
There was a problem hiding this comment.
some nits, otherwise LGTM.
# Motivation We would like to export XPUStream to public [doc](https://pytorch.org/cppdocs/api/library_root.html). The detailed documentation can help users understand and utilize XPU more effectively. # Additional Context A detailed XPUStream API and usage should be documented to public doc, like cuda's [doc](https://github.com/pytorch/pytorch/blob/main/docs/cpp/source/notes/tensor_cuda_stream.rst). cc svekars brycebortree jgong5 mingfeima XiaobingSuper sanchitintel ashokei jingxu10 [ghstack-poisoned]
|
cc @svekars do you know why the Library API does not render on the preview? How do we fix that? |
|
@svekars May I know could you please help review this RP? |
|
@svekars Could you help review this PR? |
|
@svekars it would be appreciated if you could help review this PR. |
|
@svekars may I know if you have comments on this PR? |
Thanks for your help! |
# Motivation We would like to export XPUStream to public [doc](https://pytorch.org/cppdocs/api/library_root.html). The detailed documentation can help users understand and utilize XPU more effectively. # Additional Context A detailed XPUStream API and usage should be documented to public doc, like cuda's [doc](https://github.com/pytorch/pytorch/blob/main/docs/cpp/source/notes/tensor_cuda_stream.rst). cc svekars brycebortree jgong5 mingfeima XiaobingSuper sanchitintel ashokei jingxu10 [ghstack-poisoned]
|
@pytorchbot rebase |
|
@pytorchbot started a rebase job onto refs/remotes/origin/viable/strict. Check the current status here |
|
Successfully rebased |
guangyey
added
release notes: xpu
|
@pytorchbot merge |
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 |
# Motivation We would like to export XPUStream to public [doc](https://pytorch.org/cppdocs/api/library_root.html). The detailed documentation can help users understand and utilize XPU more effectively. # Additional Context A detailed XPUStream API and usage should be documented to public doc, like cuda's [doc](https://github.com/pytorch/pytorch/blob/main/docs/cpp/source/notes/tensor_cuda_stream.rst). Pull Request resolved: pytorch#121398 Approved by: https://github.com/gujinghui, https://github.com/jgong5, https://github.com/EikanWang, https://github.com/albanD
Stack from ghstack (oldest at bottom):
Motivation
We would like to export XPUStream to public doc. The detailed documentation can help users understand and utilize XPU more effectively.
Additional Context
A detailed XPUStream API and usage should be documented to public doc, like cuda's doc.
cc @svekars @brycebortree @jgong5 @mingfeima @XiaobingSuper @sanchitintel @ashokei @jingxu10