Skip to content

Commit

Permalink
Update README with protobuf related installation (#42)
Browse files Browse the repository at this point in the history
  • Loading branch information
H-Huang authored Dec 16, 2024
1 parent 58a436d commit 8a22dc8
Showing 1 changed file with 22 additions and 3 deletions.
25 changes: 22 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Easy Per Step Fault Tolerance for PyTorch
</h3>

<p align="center">
| <a href="https://pytorch-labs.github.io/torchft/"><b>Documentation</b></a>
| <a href="https://pytorch-labs.github.io/torchft/"><b>Documentation</b></a>
| <a href="https://github.com/pytorch-labs/torchft/blob/main/media/fault_tolerance_poster.pdf"><b>Poster</b></a>
| <a href="https://docs.google.com/document/d/1OZsOsz34gRDSxYXiKkj4WqcD9x0lP9TcsfBeu_SsOY4/edit"><b>Design Doc</b></a>
|
Expand Down Expand Up @@ -45,13 +45,32 @@ greatly improve efficiency by avoiding stop the world training on errors.

![](./media/torchft-overview.png)

## Installation
## Prerequisites

Before proceeding, ensure you have the following installed:

Before proceeding, ensure you have Rust installed on your system. Note that the Rust versions available in many conda environments may be outdated. To install the latest version of Rust, we recommend downloading it directly from the official website as shown in the below command:
- Rust (with necessaray dependencies)
- `protobuf-compiler` and the corresponding development package for Protobuf.

Note that the Rust versions available in many conda environments may be outdated. To install the latest version of Rust, we recommend downloading it directly from the official website as shown in the below command:
```sh
$ curl --proto '=https' --tlsv1.2 https://sh.rustup.rs -sSf | sh
```

To install the required packages on a Debian-based system (such as Ubuntu) using apt, run:

```sh
sudo apt install protobuf-compiler libprotobuf-dev
```

or for a Red Hat-based system, run:

```sh
sudo dnf install protobuf-compiler protobuf-devel
```

## Installation

```sh
$ pip install .
```
Expand Down

0 comments on commit 8a22dc8

Please sign in to comment.