-
Notifications
You must be signed in to change notification settings - Fork 26.3k
Document LibTorch ABI more, add README to headeronly #166661
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
Conversation
[ghstack-poisoned]
🔗 Helpful Links🧪 See artifacts and rendered test results at hud.pytorch.org/pr/166661
Note: Links to docs will display an error until the docs builds have been completed. ✅ No FailuresAs of commit a70a112 with merge base e0604d3 ( This comment was automatically generated by Dr. CI and updates every 15 minutes. |
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.
Docs! 🎉 🎉
|
|
||
| The stable C headers used by AOTInductor form the foundation of the stable ABI. However, this is **use at your own risk**. For example, users must handle the memory lifecycle of objects returned by certain APIs. | ||
| Further, the stack-based APIs discussed below which allow the user to call the PyTorch dispatcher don't provide strong guarantees on forward and backward compatibility. | ||
| The stable C headers started by AOTInductor form the foundation of the stable ABI. Presently, the available C headers include: |
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.
Should we make sure that this page is properly populated and point to it: https://docs.pytorch.org/cppdocs/api/namespace_torch___stable_.html#namespace-torch--stable- ?
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.
oooh we should do that next.
|
@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 |
… (#167323) * [BE] Refresh documentation for stable ABI / API (#163899) Pull Request resolved: #163899 Approved by: https://github.com/janeyx99 * Document LibTorch ABI more, add README to headeronly (#166661) Pull Request resolved: #166661 Approved by: https://github.com/mikaylagawarecki, https://github.com/albanD * Add guidance on how to migrate kernels to the libtorch stable ABI (#167112) Pull Request resolved: #167112 Approved by: https://github.com/janeyx99 --------- Co-authored-by: Jane Xu <[email protected]>
Stack from ghstack (oldest at bottom):