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.

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

Mark SLURM detection methods in AcceleratorConnector as protected #10101

Merged
merged 10 commits into from
Oct 25, 2021

Conversation

awaelchli
Copy link
Contributor

@awaelchli awaelchli commented Oct 24, 2021

What does this PR do?

Marks two SLURM related APIs as protected.

  • AcceleratorConnector.is_slurm_managing_tasks: This is an internal bool used to select the right plugins. A user should check isinstance(trainer.cluster_environment, SLURMEnvironment) instead.
  • AcceleratorConnector.configure_slurm_ddp: This is an internal method used to set bools and select the right plugin for cluster management. A user is not meant to interact directly with this method.

I propose a short deprecation phase of 1.5-1.6 because these public methods are likely not being used by anyone.

Part of #9778
Part of #6303

Does your PR introduce any breaking changes? If yes, please list them.

Before submitting

  • Was this discussed/approved via a GitHub issue? (not for typos and docs)
  • Did you read the contributor guideline, Pull Request section?
  • Did you make sure your PR does only one thing, instead of bundling different changes together?
  • Did you make sure to update the documentation with your changes? (if necessary)
  • Did you write any new necessary tests? (not for typos and docs)
  • Did you verify new and existing tests pass locally with your changes?
  • Did you update the CHANGELOG? (not for typos, docs, test updates, or internal minor changes/refactorings)

PR review

Anyone in the community is free to review the PR once the tests have passed.
Before you start reviewing make sure you have read Review guidelines. In short, see the following bullet-list:

  • Is this pull request ready for review? (if not, please submit in draft mode)
  • Check that all items from Before submitting are resolved
  • Make sure the title is self-explanatory and the description concisely explains the PR
  • Add labels and milestones (and optionally projects) to the PR so it can be classified

Did you have fun?

I made sure I had fun coding 🙃

Part of #1 (it's a lie, this is just here to avoid noisy GitHub bot)

@awaelchli awaelchli added the deprecation Includes a deprecation label Oct 24, 2021
@awaelchli awaelchli added this to the v1.5 milestone Oct 24, 2021
@daniellepintz
Copy link
Contributor

daniellepintz commented Oct 25, 2021

if these are both internal methods, could we just skip deprecation cycle?

Copy link
Contributor

@tchaton tchaton left a comment

Choose a reason for hiding this comment

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

LGTM !

@mergify mergify bot added the ready PRs ready to be merged label Oct 25, 2021
@awaelchli
Copy link
Contributor Author

@daniellepintz If this goes into 1.5 then for us the cost will be almost 0. I marked it for removal in 1.6 so we can remove it immediately on master.

awaelchli and others added 2 commits October 25, 2021 13:58
Co-authored-by: Justus Schock <12886177+justusschock@users.noreply.github.com>
@awaelchli awaelchli enabled auto-merge (squash) October 25, 2021 12:02
@codecov
Copy link

codecov bot commented Oct 25, 2021

Codecov Report

Merging #10101 (c1f65c9) into master (d3e5a43) will decrease coverage by 4%.
The diff coverage is 95%.

@@           Coverage Diff            @@
##           master   #10101    +/-   ##
========================================
- Coverage      92%      89%    -4%     
========================================
  Files         182      182            
  Lines       16153    16164    +11     
========================================
- Hits        14940    14332   -608     
- Misses       1213     1832   +619     

@mergify mergify bot removed the has conflicts label Oct 25, 2021
@awaelchli awaelchli merged commit 76081fb into master Oct 25, 2021
@awaelchli awaelchli deleted the refactor/is_slurm_managing_tasks_0 branch October 25, 2021 17:52
ninginthecloud pushed a commit to ninginthecloud/pytorch-lightning that referenced this pull request Oct 27, 2021
…ightning-AI#10101)



Co-authored-by: Justus Schock <12886177+justusschock@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deprecation Includes a deprecation environment: slurm ready PRs ready to be merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants