Skip to content

Commit 45f9975

Browse files
authored
Add simple installation guide (#11)
* Add simple installation guide Signed-off-by: Boxiang Wang <[email protected]>
1 parent 59eec3e commit 45f9975

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,21 @@
44

55
Emerging Optimizers is a research project focused on understanding and optimizing the algorithmic behavior of Shampoo-class optimizers (Shampoo, SOAP, Muon, etc.) and their implications for performance and GPU systems in large language model training.
66

7+
## Installation
8+
9+
### Prerequisites
10+
11+
- Python 3.12 or higher
12+
- PyTorch 2.0 or higher
13+
14+
### Install from Source
15+
16+
```bash
17+
git clone https://github.com/NVIDIA-NeMo/Emerging-Optimizers.git
18+
cd Emerging-Optimizers
19+
pip install .
20+
```
21+
722
## User guide
823

924
Coming soon.

0 commit comments

Comments
 (0)