Skip to content

[docs] Add docs for non-SLURM cluster setup #5754

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

Jump to bottom
Merged
merged 8 commits into from
Feb 4, 2021
Merged

[docs] Add docs for non-SLURM cluster setup #5754

merged 8 commits into from
Feb 4, 2021

Conversation

@areshytko
Copy link
Contributor

@areshytko areshytko commented Feb 2, 2021 •
edited by Borda
Loading

What does this PR do?

Fixes #5746

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
  • Check that target branch and milestone match!

Did you have fun?

Make sure you had fun coding 🙃

@codecov
Copy link

codecov bot commented Feb 2, 2021 •
edited
Loading

Codecov Report

Merging #5754 (4d117c6) into master (90a813f) will decrease coverage by 0%.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master   #5754    +/-   ##
=======================================
- Coverage      93%     93%    -0%     
=======================================
  Files         134     134            
  Lines       10053    9913   -140     
=======================================
- Hits         9399    9247   -152     
- Misses        654     666    +12

awaelchli
awaelchli approved these changes Feb 2, 2021
View reviewed changes
Copy link
Contributor

@awaelchli awaelchli left a comment

Choose a reason for hiding this comment

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

I love these docs!

docs/source/index.rst
Comment on lines 98 to 100
slurm
cluster
child_modules
Copy link
Contributor

@awaelchli awaelchli Feb 2, 2021

Choose a reason for hiding this comment

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

just an idea, we could combine the slurm and cluster navigation items into one and make instead two sections, one for slurm and one for non-slurm

@awaelchli awaelchli added the docs Documentation related label Feb 2, 2021
@awaelchli awaelchli added this to the 1.1.x milestone Feb 2, 2021
Borda
Borda reviewed Feb 3, 2021
View reviewed changes
Copy link
Collaborator

@Borda Borda left a comment

Choose a reason for hiding this comment

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

I would rather see this change in feat 1.2

@Borda Borda added the ready PRs ready to be merged label Feb 3, 2021
@mergify mergify bot requested a review from a team February 3, 2021 09:33
@areshytko @Borda
Update docs/source/cluster.rst
a6bcf96 
Co-authored-by: Jirka Borovec <[email protected]>
s-rog
s-rog approved these changes Feb 3, 2021
View reviewed changes
Copy link
Contributor

@s-rog s-rog left a comment

Choose a reason for hiding this comment

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

Very cool, will try this myself at some point!

rohitgr7
rohitgr7 approved these changes Feb 3, 2021
View reviewed changes
@Borda Borda merged commit 0742443 into Lightning-AI:master Feb 4, 2021
tchaton added a commit that referenced this pull request Feb 5, 2021
@areshytko @oreshytko
@tchaton @Borda @awaelchli @mergify @rohitgr7
[docs] Add docs for non-SLURM cluster setup (#5754)
51d40e4 
* Add docs for non-slurm cluster setup

* Apply suggestions from code review

Co-authored-by: Adrian Wälchli <[email protected]>

* Update docs/source/cluster.rst

Co-authored-by: Jirka Borovec <[email protected]>

* Update docs/source/cluster.rst

Co-authored-by: Alexander <[email protected]>
Co-authored-by: chaton <[email protected]>
Co-authored-by: Jirka Borovec <[email protected]>
Co-authored-by: Adrian Wälchli <[email protected]>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Co-authored-by: Rohit Gupta <[email protected]>
Borda added a commit that referenced this pull request Feb 5, 2021
@areshytko @oreshytko
@tchaton @Borda @awaelchli @mergify @rohitgr7
[docs] Add docs for non-SLURM cluster setup (#5754)
0ae4dc5 
* Add docs for non-slurm cluster setup

* Apply suggestions from code review

Co-authored-by: Adrian Wälchli <[email protected]>

* Update docs/source/cluster.rst

Co-authored-by: Jirka Borovec <[email protected]>

* Update docs/source/cluster.rst

Co-authored-by: Alexander <[email protected]>
Co-authored-by: chaton <[email protected]>
Co-authored-by: Jirka Borovec <[email protected]>
Co-authored-by: Adrian Wälchli <[email protected]>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Co-authored-by: Rohit Gupta <[email protected]>
Borda added a commit that referenced this pull request Feb 5, 2021
@areshytko @oreshytko
@tchaton @Borda @awaelchli @mergify @rohitgr7
[docs] Add docs for non-SLURM cluster setup (#5754)
6d7c01b 
* Add docs for non-slurm cluster setup

* Apply suggestions from code review

Co-authored-by: Adrian Wälchli <[email protected]>

* Update docs/source/cluster.rst

Co-authored-by: Jirka Borovec <[email protected]>

* Update docs/source/cluster.rst

Co-authored-by: Alexander <[email protected]>
Co-authored-by: chaton <[email protected]>
Co-authored-by: Jirka Borovec <[email protected]>
Co-authored-by: Adrian Wälchli <[email protected]>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Co-authored-by: Rohit Gupta <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Borda Borda Borda left review comments

@justusschock justusschock justusschock approved these changes

@edenlightning edenlightning Awaiting requested review from edenlightning

@tchaton tchaton Awaiting requested review from tchaton tchaton is a code owner

+4 more reviewers

@s-rog s-rog s-rog approved these changes

@awaelchli awaelchli awaelchli approved these changes

@rohitgr7 rohitgr7 rohitgr7 approved these changes

@ydcjeff ydcjeff ydcjeff approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

docs Documentation related ready PRs ready to be merged

Projects

None yet

Milestone

pl:1.1.x

Development

Successfully merging this pull request may close these issues.

[docs] Add documentation for non-slurm computing cluster setup

9 participants

@areshytko @awaelchli @Borda @justusschock @rohitgr7 @ydcjeff @s-rog @oreshytko @tchaton