docs: make more use of the rich platform syntax - #6711
Open
ruben-arts wants to merge 3 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the PyTorch + GPU documentation examples to emphasize Pixi’s “rich platform” and [target]-based configuration, replacing multi-environment examples with per-platform targeting.
Changes:
- Switched the PyTorch CPU/GPU examples from feature/environment splitting to named rich platforms with
[target]selectors (including wildcard selectors for*-cpu/*-cuda). - Updated the PyTorch guide to explain platform selection, naming pitfalls, and using
pixi run --platform. - Revised the manifest reference’s per-feature constraints example.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| docs/source_files/pyproject_tomls/pytorch-pypi-envs.toml | Updates PyPI PyTorch example to use named rich platforms and wildcard [tool.pixi.target] selectors. |
| docs/source_files/pyproject_tomls/pytorch-conda-forge-envs.toml | Updates conda-forge PyTorch example to use named rich platforms and platform-specific targets. |
| docs/source_files/pixi_tomls/pytorch-pypi-envs.toml | Mirrors the PyPI example changes for pixi.toml format using [target."*-cpu/*-cuda"]. |
| docs/source_files/pixi_tomls/pytorch-conda-forge-envs.toml | Mirrors the conda-forge example changes for pixi.toml format using named targets. |
| docs/reference/pixi_manifest.md | Updates per-feature constraints example (needs adjustment to avoid an unrealistic Python version constraint). |
| docs/python/pytorch.md | Updates narrative and commands to reflect per-platform targeting and platform selection behavior. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Hofer-Julian
left a comment
Hofer-Julian
left a comment
Contributor
There was a problem hiding this comment.
Thanks, added a few comments
| in the `legacy-gpu` environment it sees `cuda = "<12"`. | ||
| If both features were active in the same environment the solver would receive both | ||
| constraints and would need to find a version that satisfies all of them. | ||
| The above example will produce an environment with `mkdocs` and `python` installed, but the solver will make sure that the Python version is at least 3.14.0 and that `click` is not version 8.1.7. |
Contributor
There was a problem hiding this comment.
Let's make the example an actual toml where we at least test the syntax in CI
Co-authored-by: Hofer-Julian <30049909+Hofer-Julian@users.noreply.github.com>
Co-authored-by: Hofer-Julian <30049909+Hofer-Julian@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Improving documentation related to rich platforms and gpu environments
Improving this was triggered by #6625
AI Disclosure
Tools:Claude
Checklist:
schema/model.py.