frozenleaves/pytorch
1
0
Fork 0
mirror of https://github.com/pytorch/pytorch.git synced 2025-10-20 21:14:14 +08:00
Code Issues Packages Projects Releases Wiki Activity

Updated Public API definition and documentation (markdown)

anjali411
2022-06-27 15:22:25 -04:00
parent 5d01e73f32
commit f80f7c37e2
1 changed files with 1 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
Public-API-definition-and-documentation.md

@ -1,5 +1,5 @@
**Warning:** This doc presents the end state where we want to be with our public API. And as of writing, there are still some function that "look public" even though they should be private. **Warning:** This doc presents the end state where we want to be with our public API. And as of writing, there are still some function that "look public" even though they should be private.
As of writing, if a function "looks public" and is documented on https://pytorch.org/docs, then you can rely on it being public. Otherwise, if you plan to rely on a function that is not documented on the website, please open an issue first to ask if this function is indeed public or unexpectedly exposed and might get removed in the future. As of writing this note, if a function "looks public" and is documented on https://pytorch.org/docs, then you can rely on it being public. Otherwise, if you plan to rely on a function that is not documented on the website, please open an issue first to ask if this function is indeed public or unexpectedly exposed and might get removed in the future.
# What is public API within the PyTorch project # What is public API within the PyTorch project