From 1f6e9c33919d1f70e88975277bd78d9fef145031 Mon Sep 17 00:00:00 2001 From: Oguz Ulgen Date: Wed, 8 Oct 2025 09:58:54 -0700 Subject: [PATCH] [Docs] Recommend venv instead of conda stack-info: PR: https://github.com/pytorch/helion/pull/837, branch: oulgen/stack/123 --- README.md | 13 +++++++++---- docs/installation.md | 14 ++++++++------ 2 files changed, 17 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 2460dee0d..172d4deac 100644 --- a/README.md +++ b/README.md @@ -303,10 +303,10 @@ 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: @@ -314,13 +314,18 @@ Once your environment is set up, you can install Helion directly from GitHub: 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. diff --git a/docs/installation.md b/docs/installation.md index 2e8b84676..ed739093e 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -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** @@ -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