Update README with detailed guide - #3
Conversation
* badges for GPU CI setup using Modal
🎮 GPU Test Results✅ Tests PassedSummary: ============================== 10 passed in 0.24s ============================== Full Test OutputWorkflow Run: https://github.com/Borda/affordable-GPU-CI_Modal/actions/runs/22310397715 |
There was a problem hiding this comment.
Pull request overview
This PR expands the project documentation to better explain the “GPU CI on Modal” approach and polishes GitHub Actions workflow readability, while also narrowing the GPU test workflow’s branch trigger to main.
Changes:
- Major rewrite/expansion of
README.mdwith setup, workflow explanations, and visuals. - Renamed GitHub Actions step names (emojis + clearer labels) for easier CI log scanning.
- Updated
run-gpu-tests.ymlpush trigger to run only onmain.
Reviewed changes
Copilot reviewed 5 out of 6 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Adds comprehensive “how it works”/setup guide, examples, and a screenshot reference. |
| .github/workflows/_modal-gpu-tests.yml | Step name updates for readability in the reusable GPU workflow. |
| .github/workflows/ci_testing.yml | Step name updates for readability in CPU CI workflow. |
| .github/workflows/label-gpu-tests.yml | Step name updates for readability in the PR-label triggered workflow. |
| .github/workflows/run-gpu-tests.yml | Restricts push trigger to main (and keeps manual dispatch). |
| .assets/gh-comment-modal.webp | Adds an image used by the README to illustrate PR comment output. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…and diagram layout adjustments
… and added details for clarity
…re, and improved label descriptions Refine README with improved GPU workflow diagram, updated job structure, and enhanced class definitions
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 5 out of 6 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This pull request primarily improves the project documentation and the developer experience by making the README much more comprehensive and user-friendly, and by updating GitHub Actions workflow files for clarity and maintainability. The most significant changes are grouped below by theme.
Documentation improvements:
README.mdto include detailed setup instructions, workflow explanations, free tier usage, trigger rationale, and visual aids. The new README makes it much easier for new users to understand, adopt, and adapt the GPU CI setup using Modal.Workflow and CI enhancements:
.github/workflows/_modal-gpu-tests.yml,.github/workflows/ci_testing.yml, and.github/workflows/label-gpu-tests.ymlto include emojis and more descriptive labels, improving readability and making CI logs easier to scan. [1] [2] [3] [4] [5].github/workflows/run-gpu-tests.ymlto only run onmaininstead of bothmainanddevelop, simplifying the workflow triggers.