Skip to content

Commit f8d5fba

Browse files
authored
Update install instructions (#114)
1 parent 5db0ce3 commit f8d5fba

File tree

2 files changed

+7
-23
lines changed

2 files changed

+7
-23
lines changed

README.md

Lines changed: 7 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -9,23 +9,26 @@
99
### Basic
1010

1111
Forge requires the latest PyTorch nightly with Monarch, vLLM, and torchtitan. For convenience,
12-
we have pre-packaged these dependencies as wheels in assets/wheels.
12+
we have pre-packaged these dependencies as wheels in assets/wheels. (Note that the basic install script
13+
uses [DNF](https://docs.fedoraproject.org/en-US/quick-docs/dnf/), but could be easily extended to other Linux OS.)
1314

14-
To install Forge easily:
15+
Forge requires the Github CLI (gh) to download a compatible vLLM package. See [here](https://github.com/cli/cli#installation) for gh install instructions before continuting.
1516

1617
```bash
1718
conda create -n forge python=3.10
19+
conda activate forge
1820
./scripts/install.sh
1921
```
2022

21-
You can test with
23+
After install, you can run the following command and should see output confirming GRPO training is running.
2224
```
2325
python -m apps.grpo.main
2426
```
2527

2628
If you need to re-build the wheels for whatever reason, you can do so with:
2729
```bash
2830
conda create -n forge python=3.10
31+
conda activate forge
2932
./scripts/build_wheels.sh
3033
```
3134

@@ -34,20 +37,7 @@ Since the vLLM wheel is too large for GitHub, we uploaded it as a release:
3437
$ gh release create v0.0.0 assets/wheels/vllm-*.whl --title "Forge Wheels v0.0.0"
3538
```
3639

37-
### Basic (Broken)
38-
39-
```bash
40-
pip install uv
41-
git clone https://github.com/pytorch-labs/forge
42-
cd forge
43-
uv sync
44-
45-
# Or for dev install:
46-
uv sync --all-extras
47-
```
48-
49-
50-
### Internal Machine
40+
### Meta Internal Build
5141

5242
1. Build uv package
5343

scripts/install.sh

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -197,12 +197,6 @@ EOF
197197

198198
echo ""
199199
log_info "Installation completed successfully!"
200-
log_info ""
201-
log_info "To use the environment:"
202-
log_info " conda activate $CONDA_DEFAULT_ENV"
203-
log_info ""
204-
log_info "Or add to your ~/.bashrc:"
205-
log_info " echo 'source ~/.forge_cuda_env' >> ~/.bashrc"
206200
}
207201

208202
main "$@"

0 commit comments

Comments
 (0)