Skip to content

Document OS and CPU/GPU install guidance#1077

Open
kiwoongyoon wants to merge 4 commits into
PriorLabs:mainfrom
kiwoongyoon:gitcontribute/20260627-052130-137019-PriorLabs-TabPFN-issue-158
Open

Document OS and CPU/GPU install guidance#1077
kiwoongyoon wants to merge 4 commits into
PriorLabs:mainfrom
kiwoongyoon:gitcontribute/20260627-052130-137019-PriorLabs-TabPFN-issue-158

Conversation

@kiwoongyoon

Copy link
Copy Markdown

Title: Document OS and CPU/GPU install guidance

Summary

  • Add supported environment notes to the README installation section.
  • Document the Windows/WSL2 caveat for GPU workloads.
  • Point users to the PyTorch installer selector when they want a smaller CPU-only PyTorch build or a CUDA-specific build before installing TabPFN.

Test evidence

  • python - <<'PY' ... PY passed and confirmed the README contains the expected OS and CPU/GPU installation guidance.
  • Reviewed git diff -- README.md; the patch is documentation-only.

Risks or notes for maintainers

  • The OS wording is conservative and says TabPFN is primarily tested on Linux and macOS. Please adjust if native Windows should be documented as fully supported.
  • The docs link to the PyTorch selector instead of hard-coding CPU/CUDA install URLs, so users get current commands from PyTorch.

@CLAassistant

CLAassistant commented Jun 27, 2026

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Code Review

This pull request updates the README.md to provide clearer installation instructions for TabPFN, including supported Python versions, platform recommendations (such as WSL2 for Windows), and custom PyTorch installation steps. The reviewer suggested adding an example PyTorch installation command to the two-step installation block to make the instructions more actionable.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread README.md Outdated
@kiwoongyoon kiwoongyoon marked this pull request as ready for review June 27, 2026 05:45
@kiwoongyoon kiwoongyoon requested a review from a team as a code owner June 27, 2026 05:45
@kiwoongyoon kiwoongyoon requested review from priorphil and removed request for a team June 27, 2026 05:45
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
@priorphil

priorphil commented Jun 30, 2026 via email

Copy link
Copy Markdown
Collaborator

@TuanaCelik TuanaCelik requested review from oscarkey and removed request for priorphil June 30, 2026 13:36

@oscarkey oscarkey left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

thanks for your contribution! just a few of comments/questions.

Comment thread README.md Outdated
the nightly "2.13.0.dev20260510". This enables flash attention without relying on MLX
(the latter requires a GPU-CPU-GPU roundtrip).
TabPFN supports Python 3.10+ and is primarily tested on Linux and macOS. Windows
users should prefer WSL2 for GPU workloads because PyTorch CUDA support is

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Windows users should prefer WSL2

do you happen to have a page from the pytorch docs we could link to here, to give some context?

Comment thread README.md Outdated
Comment on lines +42 to +43
# Example: Install PyTorch first (get your specific command from the selector)
pip install torch --index-url https://download.pytorch.org/whl/cpu

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
# Example: Install PyTorch first (get your specific command from the selector)
pip install torch --index-url https://download.pytorch.org/whl/cpu

I suggest we only need the first example.

Comment thread README.md Outdated
Note: For best performance on Apple Silicon/MPS, consider installing a pytorch version after
the nightly "2.13.0.dev20260510". This enables flash attention without relying on MLX
(the latter requires a GPU-CPU-GPU roundtrip).
TabPFN supports Python 3.10+ and is primarily tested on Linux and macOS. Windows

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

primarily tested on Linux and macOS

We run our full CI suite on Windows, so I don't think we need to say this. Is there a particular issue you've been facing on windows?

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.

4 participants