diff --git a/README.md b/README.md index 64eba6713..5511bc611 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,18 @@ -# image TorchForge +# image torchforge #### A PyTorch-native agentic RL library that lets you focus on algorithms—not infra. [![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) [![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) ## Overview -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. +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. Key features: - Usability for rapid research (isolating the RL loop from infrastructure) - Hackability for power users (all parts of the RL loop can be easily modified without interacting with infrastructure) - Scalability (ability to shift between async and synchronous training and across thousands of GPUs) -> ⚠️ **Early Development Warning** TorchForge is currently in an experimental +> ⚠️ **Early Development Warning** torchforge is currently in an experimental > stage. You should expect bugs, incomplete features, and APIs that may change > in future versions. The project welcomes bugfixes, but to make sure things are > well coordinated you should discuss any significant change before starting the @@ -21,7 +21,7 @@ Key features: ## 📖 Documentation (Coming Soon) -View TorchForge's hosted documentation (coming soon) +View torchforge's hosted documentation (coming soon) ## Tutorials @@ -31,11 +31,11 @@ You can also find our notebook tutorials (coming soon) ### Basic -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, +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, we have pre-packaged these dependencies as wheels in assets/wheels. (Note that the basic install script uses [DNF](https://docs.fedoraproject.org/en-US/quick-docs/dnf/), but could be easily extended to other Linux OS.) -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. +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. ```bash conda create -n forge python=3.10