pytorch/c10/core/impl/README.md
Yorkie Liu 5a9b1ddf3b fix the readme link (#56269)
Summary:
Fixes #{issue number}

Pull Request resolved: https://github.com/pytorch/pytorch/pull/56269

Reviewed By: VitalyFedyunin

Differential Revision: D27824048

Pulled By: ejguan

fbshipit-source-id: 8d5ecbdf502ae8bf8e807b55f6daeb3ff234aa62
2021-04-16 13:35:53 -07:00

815 B

c10/core/impl provides headers for functionality that is only needed in very specific use-cases (e.g., you are defining a new device type), which are generally only needed by C10 or PyTorch code. If you are an ordinary end-user, you should not use headers in this folder. We permanently give NO backwards-compatibility guarantees for implementations in this folder.

Compare with c10/util, which provides functionality that is not directly related to being a deep learning library (e.g., C++20 polyfills), but may still be generally useful and visible to users.

(We don't call this c10/detail, because the detail namespace convention is for header private details. However, c10::impl may be utilized from external headers; it simply indicates that the functionality is not for end users.)