From 79e59d0c5c5f8aa8ef80eb31f3fe918466d64c1c Mon Sep 17 00:00:00 2001 From: Ivan Yashchuk Date: Mon, 21 Oct 2024 18:26:28 +0300 Subject: [PATCH] Update Thunder installation instructions in README to use the main branch (#1331) --- README.md | 35 +++++++++-------------------------- 1 file changed, 9 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index bcac054cba..a18296adac 100644 --- a/README.md +++ b/README.md @@ -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 ``` @@ -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 -``` -
Advanced install options   -### 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 -``` - -  - ### 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: