Skip to content

Add simple installation guide #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
skyw merged 3 commits into from
Sep 19, 2025
Merged

Add simple installation guide #11

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3041455
Add simple installation guide
BoxiangW Sep 18, 2025
b7457e8
Update Python version requirement to 3.12
BoxiangW Sep 19, 2025
33a6fbe
Update installation command in README
BoxiangW Sep 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,21 @@

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.

## Installation

### Prerequisites

- Python 3.10 or higher
Copy link
Contributor

@skyw skyw Sep 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We actually need python 3.12 and higher.

Copy link
Contributor Author

@BoxiangW BoxiangW Sep 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed

- PyTorch 2.0 or higher

### Install from Source

```bash
git clone https://github.com/NVIDIA-NeMo/Emerging-Optimizers.git
cd Emerging-Optimizers
pip install -e .
Copy link
Contributor

@skyw skyw Sep 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Any reason to suggest develop install with -e?

Copy link
Contributor Author

@BoxiangW BoxiangW Sep 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think -e provides more flexibility when we are having many changes upcoming.

```

## User guide

Coming soon.