From 4cac85243bbc01c823611141729a0c310c2c72e0 Mon Sep 17 00:00:00 2001 From: Luca Antiga Date: Wed, 20 Mar 2024 15:36:50 -0700 Subject: [PATCH 1/2] Update README.md --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d5d2bc29b4..9e32d31ec9 100644 --- a/README.md +++ b/README.md @@ -36,14 +36,20 @@ pip install --pre 'nvfuser-cu121[torch]' --extra-index-url https://pypi.nvidia.c Install Thunder: +```bash +pip install lightning-thunder +``` + +It's actually not a bad idea to install directly from `main`: + ```bash pip install git+https://github.com/Lightning-AI/lightning-thunder.git ``` -or install from the local repo: +or from the local repo if you want to tinker with the internals: ```bash -pip install . +pip install -e . ``` ## Hello World From 5bedfc41bfe3fa2c3535c71e6bf572a467f5e4dc Mon Sep 17 00:00:00 2001 From: Jirka Date: Wed, 20 Mar 2024 23:56:34 +0100 Subject: [PATCH 2/2] readme: fix pre-commit link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9e32d31ec9..8f461fb518 100644 --- a/README.md +++ b/README.md @@ -172,4 +172,4 @@ See LICENSE file for details. [![CI testing](https://github.com/Lightning-AI/lightning-thunder/actions/workflows/ci-testing.yml/badge.svg?event=push)](https://github.com/Lightning-AI/lightning-thunder/actions/workflows/ci-testing.yml) [![General checks](https://github.com/Lightning-AI/lightning-thunder/actions/workflows/ci-checks.yml/badge.svg?event=push)](https://github.com/Lightning-AI/lightning-thunder/actions/workflows/ci-checks.yml) [![Documentation Status](https://readthedocs.org/projects/lightning-thunder/badge/?version=latest)](https://lightning-thunder.readthedocs.io/en/latest/?badge=latest) -[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/Lightning-AI/lightning-thunder/main.svg?badge_token=mqheL1-cTn-280Vx4cJUdg)](https://results.pre-commit.ci/latest/github/Lightning-AI/lightning-thunder/main?badge_token=mqheL1-cTn-280Vx4cJUdg) +[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/Lightning-AI/lightning-thunder/main.svg)](https://results.pre-commit.ci/latest/github/Lightning-AI/lightning-thunder/main)