Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update template.py instruction for dataloader class name #334

Merged
merged 4 commits into from
Feb 28, 2024
Merged

Update template.py instruction for dataloader class name #334

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0187195
Add documentation for dataloader class name
danjohnvelasco Jan 20, 2024
2572b29
Update template.py
sabilmakbar Feb 25, 2024
23d4638
Update REVIEWING.md
sabilmakbar Feb 25, 2024
aa2368f
Update REVIEWING.md
sabilmakbar Feb 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions REVIEWING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,8 +66,8 @@ The objective of datasheet review is to ensure that all dataloaders in SEACrowd
b. Execute `datasets.load_dataset` check based on config list (a)
c. Check on the dataset schema & few first examples for plausibility.
5. Follows some general rules/conventions:
1. `PascalCase` for dataloader class name (and “Dataset” is contained in the suffix of the class name).
2. Lowercase word characters (regex identifier: `\w`) for schema column names, including the `source` schema if the original dataset doesn’t follow it.
1. Use `PascalCase` for the dataloader class name (optional: “Dataset” can be appended to the Dataloader class name, see `templates/template.py` for example).
2. Use lowercase word characters (regex identifier: `\w`) for schema column names, including the `source` schema if the original dataset doesn’t follow it.
6. The code aligns with the `black` formatter:
use this `make check_file=seacrowd/sea_datasets/{dataloader}/{dataloader}.py`
7. Follows Dataloader Config Rule
Expand Down
3 changes: 2 additions & 1 deletion templates/template.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,8 @@
_SEACROWD_VERSION = "1.0.0"


# TODO: Name the dataset class to match the script name using CamelCase instead of snake_case
# TODO: Name the dataset class to match the script name using PascalCase instead of snake_case.
# optional: class name can append "Dataset" as suffix to provide better clarity (e.g. OSCAR 2201 --> Oscar2201Dataset/Oscar2201)
class NewDataset(datasets.GeneratorBasedBuilder):
"""TODO: Short description of my dataset."""

Expand Down