Skip to content

Commit 1590a3b

Browse files
authored
Change Forge to TorchForge in README (#454)
1 parent 5e75567 commit 1590a3b

File tree

1 file changed

+6
-11
lines changed

1 file changed

+6
-11
lines changed

README.md

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
1-
# <img width="35" height="35" alt="image" src="https://github.com/user-attachments/assets/2700a971-e5d6-4036-b03f-2f89c9791609" /> Forge
1+
# <img width="35" height="35" alt="image" src="https://github.com/user-attachments/assets/2700a971-e5d6-4036-b03f-2f89c9791609" /> TorchForge
22

33
#### A PyTorch-native agentic RL library that lets you focus on algorithms—not infra.
44
[![Unit Tests](https://github.com/meta-pytorch/forge/actions/workflows/unit_test.yaml/badge.svg?branch=main)](https://github.com/meta-pytorch/forge/actions/workflows/unit_test.yaml?query=branch%3Amain)
55
[![GPU Tests](https://github.com/meta-pytorch/forge/actions/workflows/gpu_test.yaml/badge.svg?branch=main)](https://github.com/meta-pytorch/forge/actions/workflows/gpu_test.yaml?query=branch%3Amain)
66

77
## Overview
8-
The primary purpose of the Forge ecosystem is to delineate infra concerns from model concerns thereby making RL experimentation easier. Forge delivers this by providing clear RL abstractions and one scalable implementation of these abstractions. When you need fine-grained control over placement, fault handling/redirecting training loads during a run, or communication patterns, the primitives are there. When you don’t, you can focus purely on your RL algorithm.
8+
The primary purpose of the TorchForge ecosystem is to delineate infra concerns from model concerns thereby making RL experimentation easier. TorchForge delivers this by providing clear RL abstractions and one scalable implementation of these abstractions. When you need fine-grained control over placement, fault handling/redirecting training loads during a run, or communication patterns, the primitives are there. When you don’t, you can focus purely on your RL algorithm.
99

1010
Key features:
1111
- Usability for rapid research (isolating the RL loop from infrastructure)
1212
- Hackability for power users (all parts of the RL loop can be easily modified without interacting with infrastructure)
1313
- Scalability (ability to shift between async and synchronous training and across thousands of GPUs)
1414

15-
> ⚠️ **Early Development Warning** Forge is currently in an experimental
15+
> ⚠️ **Early Development Warning** TorchForge is currently in an experimental
1616
> stage. You should expect bugs, incomplete features, and APIs that may change
1717
> in future versions. The project welcomes bugfixes, but to make sure things are
1818
> well coordinated you should discuss any significant change before starting the
@@ -21,7 +21,7 @@ Key features:
2121
2222
## 📖 Documentation (Coming Soon)
2323

24-
View Forge's hosted documentation (coming soon)
24+
View TorchForge's hosted documentation (coming soon)
2525

2626
## Tutorials
2727

@@ -31,11 +31,11 @@ You can also find our notebook tutorials (coming soon)
3131

3232
### Basic
3333

34-
Forge requires the latest PyTorch nightly with [Monarch](https://github.com/meta-pytorch/monarch), [vLLM](https://github.com/vllm-project/vllm), and [torchtitan](https://github.com/pytorch/torchtitan). For convenience,
34+
TorchForge requires the latest PyTorch nightly with [Monarch](https://github.com/meta-pytorch/monarch), [vLLM](https://github.com/vllm-project/vllm), and [torchtitan](https://github.com/pytorch/torchtitan). For convenience,
3535
we have pre-packaged these dependencies as wheels in assets/wheels. (Note that the basic install script
3636
uses [DNF](https://docs.fedoraproject.org/en-US/quick-docs/dnf/), but could be easily extended to other Linux OS.)
3737

38-
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.
38+
TorchForge 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.
3939

4040
```bash
4141
conda create -n forge python=3.10
@@ -56,11 +56,6 @@ If you need to re-build the wheels for whatever reason, you can do so with:
5656
./scripts/build_wheels.sh
5757
```
5858

59-
For your information, since the vLLM wheel is too large for GitHub, we uploaded it as a release in the `install.sh` script:
60-
```
61-
$ gh release create v0.0.0 assets/wheels/vllm-*.whl --title "Forge Wheels v0.0.0"
62-
```
63-
6459
## Quick Start
6560

6661
To run SFT on a Llama3 8B model, run

0 commit comments

Comments
 (0)