Add Datasets contribution guidelines #1798
Conversation
Great suggestion @VirgileHlav. Let me do that before landing :) |
CONTRIBUTING_DATASETS.md
Outdated
| - Number of Citations received by the dataset | ||
| - Community needs | ||
| - `Licensing concerns:` Last, but not least, make sure there are no licensing concerns over providing access to the | ||
| dataset through torchtext’s Datasets API. We have a disclaimer |
There was a problem hiding this comment.
Should we be consistent with how we refer to "TorchText"? i.e. not mixing "TorchText" with "torchtext"
There was a problem hiding this comment.
Sure, I think we can probably use all lower case (except when starting sentence in which case we can capitalize the first letter)?
CONTRIBUTING_DATASETS.md
Outdated
| Sample code to add function definition: | ||
|
|
||
| ```python | ||
| DATASET_NAME = “MyDataName” |
There was a problem hiding this comment.
nit: can we use " character here instead of “ and ”
CONTRIBUTING_DATASETS.md
Outdated
| We use mocking to implement end-2-end testing for the implemented dataset. We avoid testing using a real dataset since | ||
| it is expensive to download and/or cache the dataset for testing purposes. | ||
|
|
||
| To implement the dataset test, create the corresponding testing file `test_<datasetname>.py` under tests/datasets |
There was a problem hiding this comment.
nit: can we convert the filepath into code tests/datasets
CONTRIBUTING_DATASETS.md
Outdated
| - Samples returned on iterating over the dataset | ||
| - Dataset returned by passing split argument as `tuple` and as `str` | ||
|
|
||
| For detailed examples on how to write the test, please follow the existing test suite under tests/datasets directory. |
|
Thanks @Nayef211 for the detailed review. Let me take care of all the comments before landing :) |
Adding contribution guidelines to implement datasets based on DataPipes