Skip to content

Commit ffcc4d7

Browse files
update readme for installation
1 parent 0bc5afb commit ffcc4d7

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,16 @@ Forge requires the latest PyTorch nightly with Monarch, vLLM, and torchtitan. Fo
1212
we have pre-packaged these dependencies as wheels in assets/wheels. (Note that the basic install script
1313
uses [DNF](https://docs.fedoraproject.org/en-US/quick-docs/dnf/), but could be easily extended to other Linux OS.)
1414

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.
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. Please login to gh with your Github account before continuing with `gh auth login`. You may use either https or ssh as the protocol for authentication.
1616

1717
```bash
1818
conda create -n forge python=3.10
1919
conda activate forge
2020
./scripts/install.sh
2121
```
2222

23+
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`.
24+
2325
After install, you can run the following command and should see output confirming GRPO training is running.
2426
```
2527
python -m apps.grpo.main

0 commit comments

Comments
 (0)