Skip to content

Commit 8a22dc8

Browse files
authored
Update README with protobuf related installation (#42)
1 parent 58a436d commit 8a22dc8

File tree

1 file changed

+22
-3
lines changed

1 file changed

+22
-3
lines changed

README.md

+22-3
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Easy Per Step Fault Tolerance for PyTorch
1010
</h3>
1111

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

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

48-
## Installation
48+
## Prerequisites
49+
50+
Before proceeding, ensure you have the following installed:
4951

50-
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:
52+
- Rust (with necessaray dependencies)
53+
- `protobuf-compiler` and the corresponding development package for Protobuf.
54+
55+
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:
5156
```sh
5257
$ curl --proto '=https' --tlsv1.2 https://sh.rustup.rs -sSf | sh
5358
```
5459

60+
To install the required packages on a Debian-based system (such as Ubuntu) using apt, run:
61+
62+
```sh
63+
sudo apt install protobuf-compiler libprotobuf-dev
64+
```
65+
66+
or for a Red Hat-based system, run:
67+
68+
```sh
69+
sudo dnf install protobuf-compiler protobuf-devel
70+
```
71+
72+
## Installation
73+
5574
```sh
5675
$ pip install .
5776
```

0 commit comments

Comments
 (0)