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

add developer discussion forums

Suraj Subramanian
2023-07-24 17:50:29 -04:00
parent 467634edf3
commit 0c52ab5a82
1 changed files with 21 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
Sharing-design-documents-for-discussion.md

@ -1,8 +1,21 @@
When proposing a complex new feature or analyzing some tradeoff, plain GitHub issues might be too restrictive for the discussion. In such situations the inline commenting and rich formatting are preferred. We offer two options for that.
In PyTorch, there are 4 avenues to engage in developer discussions:
## Google docs
1. PyTorch RFCs
1. Design Docs Google Drive
1. PyTorch Developer Discussion forum
1. PyTorch Slack
PyTorch has a shared google drive for design documents called 'PyTorch Design Docs'. It's owned by `pytorch.org` domain and thus has a long term ownership not tied to the individual account.
## Request for Comments (RFCs)
To propose a new feature, you'll submit a Request For Comments (RFC). This RFC is basically a design proposal where you can share a detailed description of what change you want to make, why it's needed, and how you propose to implement it.
It's easier to make changes while your feature is in the ideation phase vs the PR phase, and this doc gives core maintainers an opportunity to suggest refinements before you start code. For example, they may know of other planned efforts that your work would otherwise collide with, or they may suggest implementation changes that make your feature more broadly usable.
Here are [detailed instructions on how to submit an RFC](https://github.com/pytorch/rfcs/blob/master/README.md)
## Design Docs Google Drive
When proposing a complex new feature or analyzing some tradeoff, plain GitHub issues might be too restrictive for the discussion. In such situations the inline commenting and rich formatting are preferred. PyTorch has a shared google drive for design documents called 'PyTorch Design Docs'. It's owned by `pytorch.org` domain and thus has a long term ownership not tied to the individual account.
The public folder on the google drive is [accessible to anyone on the internet](https://drive.google.com/drive/folders/14ZtBcdSJZTmNEIeTgGffZDb8ia0D7Kbr?usp=sharing) with permission to comment.
@ -18,6 +31,9 @@ Once you have the write access, you should see 'PyTorch Design Docs' at https://
Obtain the public link to the doc by clicking the 'Share' button. If the doc was moved to the 'PyTorch Design Docs (public)' folder, the permission should be already set to 'Anyone on the internet can comment'. You can share the link in GitHub issue, dev-discuss forum or elsewhere.
## RFC repo
Create a new `.md` file and send a PR to https://github.com/pytorch/rfcs . Discussion can happen as inline comments in the PR's review.
## PyTorch Developer Discussions forum
The [dev-discuss](dev-discuss.pytorch.org) forum is for anyone who is making contributions to PyTorch. Maintainers and developers often share designs, notes and their knowledge about the codebase. It is also a place to ask for help and share your ideas as a contributor.
## PyTorch Slack
For power users who have made multiple contributions or have already participated significantly on the forums, we have a Slack channel to discuss advanced topics in PyTorch. If you'd like to join, you can [file a request](https://docs.google.com/forms/d/e/1FAIpQLSeADnUNW36fjKjYzyHDOzEB_abKQE9b6gqqW9NXse6O0MWh0A/viewform).