You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: tutorial_submission_policy.md
+18-17Lines changed: 18 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,7 @@ We accept new tutorials that adhere to one of the following use cases:
15
15
***Demonstrate New PyTorch Features:** Tutorials that support new features
16
16
for upcoming PyTorch releases are typically authored by the engineers who
17
17
are developing these features. These tutorials are crucial for showcasing
18
-
the latest advancements in PyTorch. We typically don't require more than
18
+
the latest advancements in PyTorch. We typically do not require more than
19
19
one tutorial per feature.
20
20
21
21
***Tutorials showcasing PyTorch usage with other tools and libraries:** We
@@ -44,9 +44,9 @@ interested in contributing a tutorial, please follow these steps:
44
44
to ensure your content adheres to these guidelines.
45
45
Use the provided [ISSUE_TEMPLATE](https://github.com/pytorch/tutorials/blob/main/.github/ISSUE_TEMPLATE/feature-request.yml) for the new tutorial request - select **Feature request** when submitting an issue. .
46
46
47
-
* If there is a tutorial on the existing topic that you would like
48
-
to significantly refactor, you can just submit a PR. In the
49
-
description of the PR explain why the changes are needed and
47
+
* If there is an existing tutorial on the topic that you would
48
+
like to significantly refactor, you can submit a PR. In the
49
+
description of the PR, explain why the changes are needed and
50
50
how they improve the tutorial.
51
51
52
52
* These issues will be triaged by PyTorch maintainers on a case-by-case basis.
@@ -56,14 +56,14 @@ interested in contributing a tutorial, please follow these steps:
56
56
* Wait for a response from the PyTorch Tutorials maintainers. A PyTorch
57
57
tutorial maintainer will review your proposal and
58
58
determine whether a tutorial on the proposed topic is desirable.
59
-
A comment and an **approved** label will be added to your tutorial
60
-
by a maintainer. Review process for new tutorial PRs submitted
61
-
without the corresponding issue will take longer.
59
+
A comment and an **approved** label will be added to your issue
60
+
by a maintainer. The review process for new tutorial PRs submitted
61
+
without the corresponding issue may take longer.
62
62
63
63
1.**Adhere to writing and styling guidelines:**
64
64
* Once approved, follow the guidelines outlined in [CONTRIBUTING.md](https://github.com/pytorch/tutorials/blob/main/CONTRIBUTING.md)
65
65
and use the provided [template](https://github.com/pytorch/tutorials/blob/main/beginner_source/template_tutorial.py) for creating your tutorial.
66
-
* Link the issue in which you received an approval for your tutorial
66
+
* Link the issue in which you received approval for your tutorial
67
67
in the PR.
68
68
* We accept tutorials in both ``.rst`` (ReStructuredText) and ``.py``
69
69
(Python) formats. However, unless your tutorial involves using
@@ -73,25 +73,26 @@ interested in contributing a tutorial, please follow these steps:
73
73
74
74
## Maintaining Tutorials
75
75
76
-
When you submit a new tutorial, we encourage you to keep it updated
76
+
When you submit a new tutorial, we encourage you to keep it in sync
77
77
with the latest PyTorch updates and features. Additionally, we may
78
78
contact you to review any PRs, issues, and other related matters to
79
79
ensure the tutorial remains a valuable resource.
80
80
81
81
Please note the following:
82
82
83
-
* If a tutorial is broken against the main branch, the tutorial will
84
-
be excluded from the build and an issue will be filed against it
85
-
with the author/maintainer notified about the issue. If the issue
86
-
is not resolved within 90 days, the tutorial might be deleted from
87
-
the repository.
83
+
* If a tutorial breaks against the main branch, it will
84
+
be excluded from the build and an issue will be filed against it,
85
+
with the author/maintainer notified. If the issue is not resolved
86
+
within 90 days, the tutorial might be deleted from the repository.
88
87
89
88
* We recommend that each tutorial is reviewed at least once a year to
90
89
ensure its relevance.
91
90
92
91
## Deleting Stale Tutorials
93
92
94
-
A tutorial might be considered stale when it no longer aligns with the latest PyTorch updates, features, or best practices or:
93
+
A tutorial might be considered stale when it no longer aligns with
94
+
the latest PyTorch updates, features, or best practices or best
95
+
practices:
95
96
96
97
* The tutorial is no longer functional due to changes in PyTorch or
97
98
its dependencies
@@ -100,7 +101,7 @@ A tutorial might be considered stale when it no longer aligns with the latest Py
100
101
* The tutorial does not run successfully in the (CI), indicating
101
102
potential compatibility or dependency issues.
102
103
103
-
If a tutorial is deemed stale, we will attempt to contact the code owner
104
+
If a tutorial is deemed stale, we will attempt to contact the code owner,
104
105
or someone from the tutorial mainatainers might attempt to update it.
105
-
However, if despite those attempts, we fail to fix it, the tutorial
106
+
However, if despite those attempts we fail to fix it, the tutorial
0 commit comments