-
Notifications
You must be signed in to change notification settings - Fork 31
Create rule S6983 #3973
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.
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
Create rule S6983 #3973
Conversation
735aa81
to
e1e5ce0
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks really good! There is one possible mistake in the title, otherwise only small grammar issues.
== Why is this an issue? | ||
|
||
In the PyTorch library, the data loaders are used to provide an interface where common operations such as batching can be implemented. | ||
It is also possible to parallelize the data loading process by using multiple worker processes. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not 100% sure here but I think worker
should plurialized
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it should not be pluralized
rules/S6983/python/rule.adoc
Outdated
|
||
In the PyTorch library, the data loaders are used to provide an interface where common operations such as batching can be implemented. | ||
It is also possible to parallelize the data loading process by using multiple worker processes. | ||
This can increase performance by increasing the number of batches being fetched in parallel, at the cost of higher memory usage. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Here, to remove repetition, I would go with This can improve performance...
rules/S6983/python/metadata.json
Outdated
@@ -0,0 +1,23 @@ | |||
{ | |||
"title": "The \"nb_workers\" parameter should be specified for `torch.utils.data.DataLoader`", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this should be num_workers
instead?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! Small comment about the title. And there is one comment you did not address.
rules/S6983/python/metadata.json
Outdated
@@ -0,0 +1,23 @@ | |||
{ | |||
"title": "The \"num_workers\" parameter should be specified for `torch.utils.data.DataLoader`", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I just caught that sorry, but we should not use backticks in titles.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You forgot to remove the backticks
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! Good job.
|
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
dead7f6
to
02630aa
Compare
|
|
You can preview this rule here (updated a few minutes after each push).
Review
A dedicated reviewer checked the rule description successfully for: