Clarify supported Python versions and document CUDA dependency issues#281
Clarify supported Python versions and document CUDA dependency issues#281mahek2016 wants to merge 1 commit intoAOSSIE-Org:mainfrom
Conversation
📝 WalkthroughWalkthroughDocumentation update to the installation guide refining Python version requirements (≥ 3.10, < 3.13, with 3.11 recommended) and introducing a new GPU/CUDA dependency notice with troubleshooting guidance for NVIDIA-related package installation failures. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 5 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
Tip Issue Planner is now in beta. Read the docs and try it out! Share your feedback on Discord. 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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@docs/INSTALL_GUIDE.md`:
- Around line 55-59: Add a language tag to the fenced code block that contains
the error snippet "ERROR: No matching distribution found for nvidia-cufile-cu12"
by changing the opening triple backticks to include a language (e.g., use
```text or ```sh) so the block is lint-compliant (MD040) and displays as plain
text; locate the fenced block around that error message and update its opening
fence accordingly.
| If you encounter errors such as: | ||
|
|
||
| ``` | ||
| ERROR: No matching distribution found for nvidia-cufile-cu12 | ||
| ``` |
There was a problem hiding this comment.
Add a language to the fenced error snippet.
The fenced block for the error message lacks a language tag, triggering MD040. Suggest using text (or sh) for clarity and lint compliance.
🔧 Suggested fix
-```
-ERROR: No matching distribution found for nvidia-cufile-cu12
-```
+```text
+ERROR: No matching distribution found for nvidia-cufile-cu12
+```📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| If you encounter errors such as: | |
| ``` | |
| ERROR: No matching distribution found for nvidia-cufile-cu12 | |
| ``` | |
| If you encounter errors such as: | |
🧰 Tools
🪛 markdownlint-cli2 (0.20.0)
[warning] 57-57: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
In `@docs/INSTALL_GUIDE.md` around lines 55 - 59, Add a language tag to the fenced
code block that contains the error snippet "ERROR: No matching distribution
found for nvidia-cufile-cu12" by changing the opening triple backticks to
include a language (e.g., use ```text or ```sh) so the block is lint-compliant
(MD040) and displays as plain text; locate the fenced block around that error
message and update its opening fence accordingly.
1 participant
Closes #272
📝 Description
This pull request improves the installation and onboarding documentation for new contributors.
While setting up the project locally, I encountered issues related to unsupported Python versions and CUDA-related dependencies. These were not clearly documented, which may cause confusion for first-time contributors.
This update clarifies:
These changes reduce onboarding friction and improve the overall contributor experience.
🔧 Changes Made
ERROR: No matching distribution found for nvidia-cufile-cu12
📷 Screenshots or Visual Changes (if applicable)
Not applicable – documentation update only.
🤝 Collaboration
Collaborated with: N/A
✅ Checklist
Summary by CodeRabbit