Skip to content

Refactor README installation to recommend uv#80

Merged
nanxstats merged 2 commits intomainfrom
uv-pytorch
Jan 11, 2026
Merged

Refactor README installation to recommend uv#80
nanxstats merged 2 commits intomainfrom
uv-pytorch

Conversation

@nanxstats
Copy link
Owner

This PR:

  • Replace tedious PyTorch installation subsections in README.md with a single "Using uv" section.
  • Add a canonical example for configuring PyTorch with GPU support (Windows + CUDA 13.0).
  • Still link to uv's official PyTorch integration guide.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR modernizes the installation documentation by recommending uv as the primary package manager for tinytopics, replacing the previous multi-section approach that covered various PyTorch installation scenarios with pip. The changes streamline the documentation by providing a single canonical example using uv's configuration-based approach for GPU support.

Changes:

  • Replaced multiple PyTorch installation subsections with a unified "Using uv (recommended)" section
  • Added example configuration for PyTorch with GPU support using uv's pyproject.toml setup
  • Updated changelog entries to document the refactoring

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

File Description
README.md Replaced pip-based PyTorch installation instructions with uv-based workflow and configuration example
docs/index.md Mirror of README.md changes for consistency in documentation
CHANGELOG.md Added entry documenting the installation refactoring
docs/changelog.md Added entry documenting the installation refactoring

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@nanxstats nanxstats merged commit 3d154d3 into main Jan 11, 2026
14 checks passed
@nanxstats nanxstats deleted the uv-pytorch branch January 11, 2026 15:22
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