Skip to content

Commit

Permalink
Update Thunder installation instructions in README to use the main br…
Browse files Browse the repository at this point in the history
…anch (#1331)
  • Loading branch information
IvanYashchuk authored Oct 21, 2024
1 parent 947e9ef commit 79e59d0
Showing 1 changed file with 9 additions and 26 deletions.
35 changes: 9 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,12 +73,18 @@ The easiest way to get started with Thunder, requiring no extra installations or

## Install Thunder

To use Thunder on your local machine:
Thunder is in alpha and the latest development is happening on the `main` branch. You can install the latest version of Thunder from the `main` branch as follows:

- install [nvFuser](https://github.com/NVIDIA/Fuser) and PyTorch stable together as follows:
```bash
pip install git+https://github.com/Lightning-AI/lightning-thunder.git@main
```

To achieve the best performance, you can install Thunder with the following additional dependencies:

- install nightly [nvFuser](https://github.com/NVIDIA/Fuser) built for PyTorch 2.4 as follows:

```bash
# install nvFuser which installs the matching stable PyTorch
# install nvFuser built for the matching stable PyTorch
pip install --pre nvfuser-cu121-torch24
```

Expand All @@ -89,35 +95,12 @@ pip install --pre nvfuser-cu121-torch24
pip install nvidia-cudnn-frontend
```

- Finally, install Thunder as follows:

```
# install thunder
pip install lightning-thunder
```

<details>
<summary>Advanced install options</summary>
<!-- following section will be skipped from PyPI description -->

&#160;

### Install from main

Alternatively, you can install the latest version of Thunder directly from this GitHub repository as follows:

```
# 1) Install nvFuser and PyTorch dependencies:
pip install --pre nvfuser-cu121-torch24
```

```bash
# 2) Install Thunder itself
pip install git+https://github.com/Lightning-AI/lightning-thunder.git
```

&#160;

### Install to tinker and contribute

If you are interested in tinkering with and contributing to Thunder, we recommend cloning the Thunder repository and installing it in pip's editable mode:
Expand Down

0 comments on commit 79e59d0

Please sign in to comment.