Skip to content

Commit 2016ab1

Browse files
authored
[Docs] Recommend venv instead of conda (#837)
1 parent 69d966f commit 2016ab1

File tree

2 files changed

+17
-10
lines changed

2 files changed

+17
-10
lines changed

README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -303,24 +303,29 @@ Helion currently targets Linux systems and requires a recent Python and PyTorch
303303

304304
## Installation
305305

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

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

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

313313
```bash
314314
pip install git+https://github.com/pytorch/helion.git
315315
```
316316

317-
Alternatively, you may install from source for development purposes:
317+
Alternatively, you may install from source for development purposes. If using `uv`, create and activate a virtual environment first:
318318
```bash
319319
git clone https://github.com/pytorch/helion.git
320320
cd helion
321+
322+
# Create and activate a virtual environment with uv (one-time)
323+
uv venv .venv
324+
source .venv/bin/activate
325+
321326
# To install in editable w/ required dev packages
322327
pip install -e .'[dev]'
323-
````
328+
```
324329
This installs Helion in "editable" mode so that changes to the source
325330
code take effect without needing to reinstall.
326331

docs/installation.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Helion currently targets Linux systems and requires a recent Python and PyTorch
1010

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

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

4848
## Step-by-Step Setup Guide
4949

50-
### 1. Set Up Conda Environment
50+
### 1. Create and Activate a uv Virtual Environment
5151

52-
We recommend using conda to manage dependencies:
52+
We recommend using uv to manage dependencies:
5353

5454
```bash
55-
# Create a new environment
56-
conda create -n helion python=3.12
57-
conda activate helion
55+
# Create a new virtual environment in .venv (one-time)
56+
uv venv .venv
57+
58+
# Activate the environment
59+
source .venv/bin/activate
5860
```
5961

6062
### 2. Install PyTorch Nightly

0 commit comments

Comments
 (0)