Skip to content

Clarify supported Python versions and document CUDA dependency issues #281

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

Open
mahek2016 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Clarify supported Python versions and document CUDA dependency issues #281

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 29 additions & 2 deletions docs/INSTALL_GUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,10 @@ For Setup guide video tutorial go to [Devr Setup Guide](https://drive.google.com

## Prerequisites

- [Python](https://www.python.org/) 3.9+ (version 3.10 is recommended)
- [Python](https://www.python.org/) >= 3.10 and < 3.13 (Python 3.11 is recommended)

⚠️ Python 3.13 is currently not supported and may cause dependency installation errors (e.g., crewai or CUDA-related packages failing to install).

- [Node.js](https://nodejs.org/en) (latest LTS version)
- [Git](https://git-scm.com/) (any recent version)
- [Docker](https://www.docker.com/) and [Docker Compose](https://docs.docker.com/compose/) (for Weaviate database)
Expand All @@ -32,10 +35,34 @@ poetry --version # Should show v2.0.0 or above

3. **Install Python dependencies**
```sh
poetry env use python3.10
poetry env use python3.11
poetry lock
poetry install --with dev
```
### ⚠️ GPU / CUDA Dependency Notice

The backend includes NVIDIA CUDA-related dependencies such as:

- nvidia-cuda-runtime-cu12
- nvidia-cudnn-cu12
- nvidia-cufile-cu12

These may fail to install on systems without:

- NVIDIA GPU
- Compatible CUDA drivers

If you encounter errors such as:

```
ERROR: No matching distribution found for nvidia-cufile-cu12
```
Comment on lines +55 to +59
Copy link
Contributor

@coderabbitai coderabbitai bot Feb 16, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

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.

Suggested change
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.



Consider:
- Using a CUDA-enabled Linux environment
- Or running the project via Docker (recommended for consistent setup)


4. **Activate the virtual environment**
```sh
Expand Down