Skip to content

Conversation

@cmeesters
Copy link
Member

@cmeesters cmeesters commented Aug 21, 2025

just a minor addendum to the docs

Summary by CodeRabbit

  • Documentation
    • Clarified GPU/SLURM behavior: if cpus_per_gpu or tasks_per_gpu are zero or negative, no CPU request is made and the SLURM flag --ntasks-per-gpu is not set.
    • Improved guidance to help users avoid unintended resource requests when configuring GPU jobs.
    • Documentation-only update; no changes to runtime behavior or interfaces.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Aug 21, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

Documentation update in docs/further.md clarifies SLURM behavior: if cpus_per_gpu <= 0 or tasks_per_gpu <= 0, no CPU request is made and --ntasks-per-gpu is not set. No code or API changes.

Changes

Cohort / File(s) Summary of Changes
Docs: GPU/SLURM clarification
docs/further.md
Added note that non-positive cpus_per_gpu or tasks_per_gpu results in omitting --ntasks-per-gpu and no CPU request; documentation-only update.

Sequence Diagram(s)

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

Suggested reviewers

  • dlaehnemann
  • fgvieira

Poem

A rabbit taps notes in the SLURM-lit night,
“Zero or less? Then CPUs take flight.”
No tasks per GPU, no flags to show—
Docs now whisper what schedulers know.
I thump with joy, concise and bright! 🐇✨

Tip

🔌 Remote MCP (Model Context Protocol) integration is now available!

Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats.


📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 58d471d and 06dbecc.

📒 Files selected for processing (1)
  • docs/further.md (1 hunks)
✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs/minor_fixes

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@cmeesters cmeesters merged commit adcd86e into main Aug 21, 2025
4 of 5 checks passed
@cmeesters cmeesters deleted the docs/minor_fixes branch August 21, 2025 14:54
cmeesters pushed a commit that referenced this pull request Aug 21, 2025
🤖 I have created a release *beep* *boop*
---


##
[1.6.1](v1.6.0...v1.6.1)
(2025-08-21)


### Bug Fixes

* efficiency report jobsteps
([#338](#338))
([a4cbe36](a4cbe36))
* gpu tasks are unset if &lt;= 0
([#347](#347))
([564e0f7](564e0f7))
* updated poetry
([#343](#343))
([58d471d](58d471d))


### Documentation

* added notes about ntasks per gpu
([#346](#346))
([adcd86e](adcd86e))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

- Bug Fixes
  - Corrected efficiency report job step handling.
  - Prevented invalid GPU task settings by unsetting values ≤ 0.
- Documentation
  - Added guidance on configuring tasks per GPU.
- Chores
  - Updated packaging tooling and version to 1.6.1.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants