@@ -86,8 +86,8 @@ the checks automatically before every `git commit`, you can install them with `p
86
86
87
87
When adding a new DataPipe, there are few things that need to be done to ensure it is working and documented properly.
88
88
89
- 1 . Naming - please following the naming convention as
90
- [ described here] ( https://github.com/pytorch/ data/blob/ main/docs/source/tutorial.rst #naming ) .
89
+ 1 . Naming - please follow the naming convention as
90
+ [ described here] ( https://pytorch.org/ data/main/dp_tutorial.html #naming ) .
91
91
2 . Testing - please add unit tests to ensure that the DataPipe is functioning properly. Here are the
92
92
[ test requirements] ( https://github.com/pytorch/data/issues/106 ) that we have.
93
93
- One test that is commonly missed is the serialization test. Please add the new DataPipe to
@@ -98,14 +98,14 @@ When adding a new DataPipe, there are few things that need to be done to ensure
98
98
3 . Documentation - ensure that the DataPipe has docstring, usage example, and that it is added to the right category of
99
99
the right RST file to be rendered.
100
100
- If your DataPipe has a functional form (i.e. ` @functional_datapipe(...) ` ), include at the
101
- [ end of the first sentence] ( https://github.com/pytorch/data/blob/main/torchdata/datapipes/iter/util/combining.py#L119 )
101
+ [ end of the first sentence] ( https://github.com/pytorch/data/blob/main/torchdata/datapipes/iter/util/combining.py#L25 )
102
102
of your docstring. This will make sure it correctly shows up in the
103
103
[ summary table] ( https://pytorch.org/data/main/torchdata.datapipes.iter.html#archive-datapipes ) of our
104
104
documentation.
105
105
4 . Import - import the DataPipe in the correct ` __init__.py ` file.
106
106
5 . Interface - if the DataPipe has a functional form, make sure that is generated properly by ` gen_pyi.py ` into the
107
107
relevant interface file.
108
- - You can re-generate the pyi files by re-running ` python setup.py develop ` , then you can examine the new outputs.
108
+ - You can re-generate the pyi files by re-running ` pip install -e . ` , then you can examine the new outputs.
109
109
110
110
## Contributor License Agreement ("CLA")
111
111
0 commit comments