Skip to content

Commit 557a00c

Browse files
remove confusing uv installation instruction from READEME.md (#537)
Co-authored-by: Jiyue (Jennifer) Wang <jiyue@meta.com>
1 parent f55bac8 commit 557a00c

File tree

1 file changed

+5
-22
lines changed

1 file changed

+5
-22
lines changed

README.md

Lines changed: 5 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -30,40 +30,23 @@ You can also find our notebook tutorials (coming soon)
3030

3131
## Installation
3232

33-
### Basic
34-
3533
torchforge requires PyTorch 2.9.0 with [Monarch](https://github.com/meta-pytorch/monarch), [vLLM](https://github.com/vllm-project/vllm), and [torchtitan](https://github.com/pytorch/torchtitan).
3634

37-
You can install Forge with:
38-
```
39-
$ conda create -n forge python=3.10
40-
$ conda activate forge
41-
$ uv pip install .
42-
```
43-
44-
(conda-less uv install is a wip)
45-
46-
For your reference, we also include a basic install script that installs other system dependencies
47-
along with torchforge:
48-
(note that this basic install script
49-
uses [DNF](https://docs.fedoraproject.org/en-US/quick-docs/dnf/), but could be easily extended to other Linux OS.)
35+
Install torchforge with:
5036

5137
```bash
5238
conda create -n forge python=3.12
5339
conda activate forge
5440
./scripts/install.sh
5541
```
5642

57-
Optional: By default, the packages installation uses conda. If user wants to install system packages on the target machine instead of conda, they can pass the `--use-sudo` to the installation script: `./script/install.sh --use-sudo`.
43+
The install script installs system dependencies along with torchforge. Note that this install script uses [DNF](https://docs.fedoraproject.org/en-US/quick-docs/dnf/), but could be easily extended to other Linux OS.
5844

59-
After install, you can run the following command and should see output confirming GRPO training is running (you need a minimum 3 GPU devices):
45+
Optional: By default, the packages installation uses conda. If you want to install system packages on the target machine instead of conda, you can pass the `--use-sudo` flag to the installation script: `./scripts/install.sh --use-sudo`.
6046

47+
> **Note:** We are actively working on enabling pure `uv` installation. Currently, Conda is the recommended approach. `uv` support is not fully working at the moment but is being tracked in [issue #494](https://github.com/meta-pytorch/torchforge/issues/494).
6148
62-
```
63-
uv run apps/grpo/main.py --config apps/grpo/qwen3_1_7b.yaml
64-
```
65-
66-
or if not using uv:
49+
After install, you can run the following command and should see output confirming GRPO training is running (you need a minimum 3 GPU devices):
6750

6851
```
6952
python -m apps.grpo.main --config apps/grpo/qwen3_1_7b.yaml

0 commit comments

Comments
 (0)