Skip to content

[Docs] Recommend venv instead of conda #837

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

Merged
merged 1 commit into from
Oct 8, 2025
Merged

[Docs] Recommend venv instead of conda #837

Show file tree
Hide file tree
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
13 changes: 9 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -303,24 +303,29 @@ Helion currently targets Linux systems and requires a recent Python and PyTorch

## Installation

We recommend using a [conda] environment to manage dependencies. First,
We recommend using [uv] to manage an isolated virtual environment. First,
install compatible versions of [PyTorch] and [Triton].

[conda]: https://www.anaconda.com/docs/getting-started/miniconda/install
[uv]: https://docs.astral.sh/uv/

Once your environment is set up, you can install Helion directly from GitHub:

```bash
pip install git+https://github.com/pytorch/helion.git
```

Alternatively, you may install from source for development purposes:
Alternatively, you may install from source for development purposes. If using `uv`, create and activate a virtual environment first:
```bash
git clone https://github.com/pytorch/helion.git
cd helion

# Create and activate a virtual environment with uv (one-time)
uv venv .venv
source .venv/bin/activate

# To install in editable w/ required dev packages
pip install -e .'[dev]'
````
```
This installs Helion in "editable" mode so that changes to the source
code take effect without needing to reinstall.

Expand Down
14 changes: 8 additions & 6 deletions docs/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Helion currently targets Linux systems and requires a recent Python and PyTorch

### Python Environment
- **Python 3.10, 3.11, or 3.12**
- We recommend using [conda](https://www.anaconda.com/docs/getting-started/miniconda/install) for environment management
- We recommend using [uv](https://docs.astral.sh/uv/) for lightweight, fast virtual environments

### Dependencies
- **[PyTorch](https://github.com/pytorch/pytorch) nightly build**
Expand Down Expand Up @@ -47,14 +47,16 @@ This installs Helion in "editable" mode so that changes to the source code take

## Step-by-Step Setup Guide

### 1. Set Up Conda Environment
### 1. Create and Activate a uv Virtual Environment

We recommend using conda to manage dependencies:
We recommend using uv to manage dependencies:

```bash
# Create a new environment
conda create -n helion python=3.12
conda activate helion
# Create a new virtual environment in .venv (one-time)
uv venv .venv

# Activate the environment
source .venv/bin/activate
```

### 2. Install PyTorch Nightly
Expand Down
Loading