From 3012f4d70d8a95776eef401e2a886168fce22353 Mon Sep 17 00:00:00 2001 From: Philip Bontrager Date: Fri, 12 Jul 2024 12:33:07 -0700 Subject: [PATCH] updated dev install instructions --- CONTRIBUTING.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a301aab3f1..77663848ff 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,12 +5,17 @@ We want to make contributing to this project as easy and transparent as possible ## Dev install You should first [fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo) the torchtune repository -and then clone your forked repository. +and then clone your forked repository. Make sure to keep your fork in sync with the torchtune repository over time. ```git clone https://github.com//torchtune.git``` Then navigate into the newly cloned repo and install dependencies needed for development. +**Step 1:** [Install PyTorch](https://pytorch.org/get-started/locally/). torchtune is tested with the latest stable PyTorch release as well as the preview nightly version. + + +**Step 2:** Install all the additional dependencies and dev dependencies in the local repo: + ``` cd torchtune pip install -e ".[dev]"