File tree Expand file tree Collapse file tree 2 files changed +36
-5
lines changed Expand file tree Collapse file tree 2 files changed +36
-5
lines changed Original file line number Diff line number Diff line change @@ -113,14 +113,28 @@ ______________________________________________________________________
113113
114114To set up a local development environment, we recommend using ` uv ` , which can be installed following their [ instructions] ( https://docs.astral.sh/uv/getting-started/installation/ ) .
115115
116- Once ` uv ` has been installed, begin by cloning the repository:
116+ Once ` uv ` has been installed, begin by cloning the forked repository:
117117
118118``` bash
119- git clone https://github.com/Lightning-AI/ lightning.git
120- cd lightning
119+ git clone https://github.com/{YOUR_GITHUB_USERNAME}/pytorch- lightning.git
120+ cd pytorch- lightning
121121```
122122
123- Once in root level of the repository, create a new virtual environment and install the project dependencies.
123+ > If you're using [ Lightning Studio] ( https://lightning.ai ) or already have your ` uv venv ` activated, you can quickly set up the project by running:
124+
125+ ``` bash
126+ make setup
127+ ```
128+
129+ This will:
130+
131+ - Install all required dependencies.
132+ - Perform an editable install of the ` pytorch-lightning ` project.
133+ - Install and configure ` pre-commit ` .
134+
135+ #### Manual Setup (Optional)
136+
137+ If you prefer more fine-grained control over the dependencies, you can set up the environment manually:
124138
125139``` bash
126140uv venv
Original file line number Diff line number Diff line change 1- .PHONY : test clean docs
1+ .PHONY : test clean docs setup
22
33# to imitate SLURM set only single node
44export SLURM_LOCALID =0
@@ -7,6 +7,23 @@ export SPHINX_MOCK_REQUIREMENTS=1
77# install only Lightning Trainer packages
88export PACKAGE_NAME =pytorch
99
10+ setup :
11+ uv pip install -r requirements.txt \
12+ -r requirements/pytorch/base.txt \
13+ -r requirements/pytorch/test.txt \
14+ -r requirements/pytorch/extra.txt \
15+ -r requirements/pytorch/strategies.txt \
16+ -r requirements/fabric/base.txt \
17+ -r requirements/fabric/test.txt \
18+ -r requirements/fabric/strategies.txt \
19+ -r requirements/typing.txt \
20+ -e " .[all]" \
21+ pre-commit
22+ pre-commit install
23+ @echo " -----------------------------"
24+ @echo " ✅ Environment setup complete. Ready to Contribute ⚡️!"
25+
26+
1027clean :
1128 # clean all temp runs
1229 rm -rf $(shell find . -name "mlruns")
You can’t perform that action at this time.
0 commit comments