Skip to content

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

Merged
merged 4 commits into from
Sep 16, 2024
Merged

Create rule S6983 #3973

merged 4 commits into from
Sep 16, 2024

Conversation

github-actions[bot]
Copy link
Contributor

@github-actions github-actions bot commented Jun 5, 2024

You can preview this rule here (updated a few minutes after each push).

Review

A dedicated reviewer checked the rule description successfully for:

  • logical errors and incorrect information
  • information gaps and missing content
  • text style and tone
  • PR summary and labels follow the guidelines

Copy link
Contributor

@joke1196 joke1196 left a 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.
Copy link
Contributor

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

Copy link
Contributor

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


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.
Copy link
Contributor

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...

@@ -0,0 +1,23 @@
{
"title": "The \"nb_workers\" parameter should be specified for `torch.utils.data.DataLoader`",
Copy link
Contributor

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?

@ghislainpiot ghislainpiot requested a review from joke1196 June 6, 2024 09:59
Copy link
Contributor

@joke1196 joke1196 left a 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.

@@ -0,0 +1,23 @@
{
"title": "The \"num_workers\" parameter should be specified for `torch.utils.data.DataLoader`",
Copy link
Contributor

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.

Copy link
Contributor

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

@ghislainpiot ghislainpiot requested a review from joke1196 June 6, 2024 12:18
Copy link
Contributor

@joke1196 joke1196 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Good job.

Copy link

sonarqube-next bot commented Jun 6, 2024

Quality Gate passed Quality Gate passed for 'rspec-frontend'

Issues
0 New issues
0 Fixed issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarQube

Copy link

sonarqube-next bot commented Jun 6, 2024

Quality Gate passed Quality Gate passed for 'rspec-tools'

Issues
0 New issues
0 Fixed issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarQube

Copy link

@jean-jimbo-sonarsource jean-jimbo-sonarsource left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@Seppli11 Seppli11 force-pushed the rule/add-RSPEC-S6983 branch from dead7f6 to 02630aa Compare September 16, 2024 13:17
@Seppli11 Seppli11 marked this pull request as ready for review September 16, 2024 13:17
Copy link

Quality Gate passed Quality Gate passed for 'rspec-tools'

Issues
0 New issues
0 Fixed issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarQube

Copy link

Quality Gate passed Quality Gate passed for 'rspec-frontend'

Issues
0 New issues
0 Fixed issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarQube

@Seppli11 Seppli11 merged commit 596ee15 into master Sep 16, 2024
9 of 10 checks passed
@Seppli11 Seppli11 deleted the rule/add-RSPEC-S6983 branch September 16, 2024 13:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants