mirror of
https://github.com/saymrwulf/pytorch.git
synced 2026-05-14 20:57:59 +00:00
a8a44a1aa2
This PR: - adds deprecation warnings when calling the functorch APIs - adds documentation saying that those APIs are deprecated It does this by creating thin wrappers around the original APIs that (1) raise deprecation warnings and (2) have an additional line in their documentation that they are deprecated. NB: - Python surpresses DeprecationWarning, so we use UserWarning instead. Test Plan: - New tests - the functorch.* APIs are still tested for correctness because that's what test/functorch/* use (as opposed to directly calling the torch.func.* APIs) Pull Request resolved: https://github.com/pytorch/pytorch/pull/92279 Approved by: https://github.com/albanD, https://github.com/soulitzer |
||
|---|---|---|
| .. | ||
| source | ||
| .gitignore | ||
| Makefile | ||
| README.md | ||
| requirements.txt | ||
functorch docs build
Build Locally
Install requirements:
pip install -r requirements.txt
One may also need to install pandoc. On Linux we can use: sudo apt-get install pandoc. Or using conda we can use: conda install -c conda-forge pandoc.
To run the docs build:
make html
Check out the output files in build/html.
Deploy
The functorch docs website does not updated automatically. We need to periodically regenerate it.
You need write permissions to functorch to do this. We use GitHub Pages to serve docs.
- Build the docs
- Save the build/html folder somewhere
- Checkout the branch
gh-pages. - Delete the contents of the branch and replace it with the build/html folder.
index.htmlshould be at the root. - Commit the changes and push the changes to the
gh-pagesbranch.