Skip to content

docs(phase-00): add macOS/MPS branch to env-check prompt#317

Open
bhuiyanmobasshir94 wants to merge 1 commit into
rohitg00:mainfrom
bhuiyanmobasshir94:docs/macos-mps-env-check
Open

docs(phase-00): add macOS/MPS branch to env-check prompt#317
bhuiyanmobasshir94 wants to merge 1 commit into
rohitg00:mainfrom
bhuiyanmobasshir94:docs/macos-mps-env-check

Conversation

@bhuiyanmobasshir94

Copy link
Copy Markdown

What

The prompt-env-check diagnostician prompt (Phase 0, Lesson 1) told all users to handle "CUDA not detected" by running nvidia-smi and reinstalling PyTorch with a CUDA version. On macOS / Apple Silicon there is no CUDA and no nvidia-smi, so that advice loops with no resolution.

Change

Split the CUDA bullet into two:

  • Linux/Windows + NVIDIA — keep the existing nvidia-smi + CUDA-versioned reinstall path.
  • macOS / Apple Silicon — new branch: no CUDA is expected (not a failure), do not use --index-url .../cuXXX, install plain uv pip install torch torchvision torchaudio, and verify the MPS (Metal) backend with torch.backends.mps.is_available().

Why

Following the original CUDA command on a Mac fails — download.pytorch.org/whl/cu124 has no macosx_arm64 wheels. Verified locally that the plain install yields a working MPS build:

torch 2.12.1
CUDA avail: False     # expected on Mac
MPS avail: True

verify.py passes 7/7 core checks after setup.

Refs #316

🤖 Generated with Claude Code

The CUDA-not-detected guidance pointed all users at `nvidia-smi` and a
CUDA-versioned PyTorch reinstall. On macOS / Apple Silicon there is no
CUDA and no `nvidia-smi`, so that advice loops. Split the bullet:
Linux/Windows+NVIDIA keep the CUDA path; macOS gets an MPS branch that
says no CUDA is expected, skip `--index-url .../cuXXX`, install plain
torch, and verify `torch.backends.mps.is_available()` is True.

Refs rohitg00#316

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Jun 29, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 6327b984-bbfc-402b-a449-f28450f275fd

📥 Commits

Reviewing files that changed from the base of the PR and between c8b9b92 and cd3ad3a.

📒 Files selected for processing (1)
  • phases/00-setup-and-tooling/01-dev-environment/outputs/prompt-env-check.md

📝 Walkthrough

Walkthrough

The prompt-env-check.md file's "Common issues and fixes" section is updated to scope the CUDA-not-detected bullet to Linux/Windows + NVIDIA and adds a new macOS/Apple Silicon note explaining CUDA is unavailable there, with plain Torch install instructions and an MPS verification command.

Changes

CUDA/MPS Platform Documentation

Layer / File(s) Summary
Platform-specific CUDA/MPS troubleshooting
phases/00-setup-and-tooling/01-dev-environment/outputs/prompt-env-check.md
CUDA-not-detected guidance is scoped to Linux/Windows + NVIDIA; a new macOS/Apple Silicon subsection is added with plain torch install guidance and an MPS availability verification command.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related issues

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main change: adding a macOS/MPS branch to the env-check prompt.
Description check ✅ Passed The description directly matches the changeset and explains the Linux/Windows versus macOS split.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

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

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.

1 participant