Skip to content

Commit e9aea00

Browse files
authored
README: Add PyPI instruction (#219)
This adds PyPI installation instructions to the README to install the nightly build. This means end users don't need to install rust or protoc.
1 parent 9241a8b commit e9aea00

File tree

1 file changed

+20
-2
lines changed

1 file changed

+20
-2
lines changed

README.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,25 @@ train loop to ensure everything stays consistent during a healing operation.
116116

117117
See the design doc linked above for more details.
118118

119-
## Prerequisites
119+
## Installing from PyPI
120+
121+
We have nighty builds available at https://pypi.org/project/torchft-nightly/
122+
123+
To install torchft with minimal dependencies you can run:
124+
125+
```sh
126+
pip install torchft-nightly
127+
```
128+
129+
If you want all development dependencies you can install:
130+
131+
```sh
132+
pip install torchft-nightly[dev]
133+
```
134+
135+
## Installing from Source
136+
137+
### Prerequisites
120138

121139
Before proceeding, ensure you have the following installed:
122140

@@ -141,7 +159,7 @@ or for a Red Hat-based system, run:
141159
sudo dnf install protobuf-compiler protobuf-devel
142160
```
143161

144-
## Installation
162+
### Installation
145163

146164
```sh
147165
pip install .

0 commit comments

Comments
 (0)