|
| 1 | +# PyTorch Tutorial Submission Policy |
| 2 | + |
| 3 | +This policy outlines the criteria and process for submitting new tutorials to the PyTorch community. |
| 4 | +Our goal is to ensure that all tutorials are of high quality, relevant, and up-to-date, supporting |
| 5 | +both the growth of our users and the evolution of the PyTorch framework itself. By following these |
| 6 | +guidelines, contributors can help us maintain a robust and informative educational environment. |
| 7 | + |
| 8 | +## Acceptance Criteria For New Tutorials |
| 9 | +We are committed to enhancing the learning experience for PyTorch users by providing high-quality |
| 10 | +tutorials. We accept new tutorials that adhere to one of the following use cases: |
| 11 | + |
| 12 | +* **Support for New PyTorch Features:** Tutorials that support new features for upcoming PyTorch |
| 13 | +releases are typically authored by the engineers who are developing these features. These tutorials |
| 14 | +are crucial for showcasing the latest advancements in PyTorch. |
| 15 | + |
| 16 | +* **Tutorials from PyTorch Partners:** We welcome tutorials from our partners who are actively |
| 17 | + collaborating with us to grow the PyTorch ecosystem. |
| 18 | + |
| 19 | +* **Direct Requests from PyTorch Maintainers:** If a PyTorch maintainer has directly reached out |
| 20 | + to you to request a tutorial or otherwise, endorsed a tutorial, this indicates a specific need |
| 21 | + within the community or the project. |
| 22 | + |
| 23 | +* **Tutorials from the open-source community members:** We accept tutorials from the community |
| 24 | + members. However, as we can't accept all of them, we have identified the process below. |
| 25 | + Please read below before sending a PR. |
| 26 | + |
| 27 | +The first three use cases do not require following the submission process described below. |
| 28 | +If your tutorial falls under the fourth category, please read and follow the instructions in |
| 29 | +the **Submission Process For Community-Contributed Tutorials** section. |
| 30 | + |
| 31 | +## Submission Process For Community-Contributed Tutorials |
| 32 | + |
| 33 | +To maintain the quality and relevance of tutorials, community-contributed tutorials must undergo |
| 34 | +a review process. If you are interested in contributing a tutorial, please follow these steps: |
| 35 | + |
| 36 | +1. **Create an issue:** |
| 37 | + * Open an issue in the pytorch/tutorials repository proposing the new tutorial. Clearly |
| 38 | + explain the importance of the tutorial and confirm that there is no existing tutorial |
| 39 | + covering the same or similar topic. A tutorial can't endorse one technology over another. |
| 40 | + * These issues will be triaged by PyTorch maintainers on a case-by-case basis. |
| 41 | + * Link any supporting materials including discussions in other repositories". |
| 42 | + |
| 43 | +1. **Await Approval:** |
| 44 | + * Wait for a response from the PyTorch maintainers. They will review your proposal and |
| 45 | + determine whether a tutorial on the proposed topic is desirable. **Do not submit a PR with |
| 46 | + your tutorial** before you receive an approval. |
| 47 | + |
| 48 | +1. **Adhere to writing and styling guidelines:** |
| 49 | + * Once approved, follow the guidelines outlined in [CONTRIBUTING.md](https://github.com/pytorch/tutorials/blob/main/CONTRIBUTING.md) |
| 50 | + and use the provided [template](https://github.com/pytorch/tutorials/blob/main/beginner_source/template_tutorial.py) for creating your tutorial. |
| 51 | + * Link the issue where you received an approval for your tutorial in the PR. |
| 52 | + * We accept tutorials in both ``.rst`` (ReStructuredText) and ``.py`` (Python) |
| 53 | + formats. However, unless your tutorial involves using multiple GPU, parallel/distributed |
| 54 | + training, or requires extended execution time (25 minutes or more), we prefer submissions |
| 55 | + in Python file format versus ``.rst``. |
| 56 | + |
| 57 | +1. **Maintenance:** |
| 58 | + * By submitting a new tutorial, you agree to maintain it up-to-date with the latest PyTorch |
| 59 | + updates and new features, review issues and pull requests and bugs submitted against the |
| 60 | + tutorials and overall take proactive actions to ensure quality of the tutorial. |
| 61 | + * Each tutorial must be updated by its owners at least once a year. Tutorials that are |
| 62 | + abandoned by the owners will be eventually deprecated. |
| 63 | + |
| 64 | +We reserve the right to decline any new tutorial submissions that do not follow this policy. |
0 commit comments