Skip to content

Commit 79eceaa

Browse files
BordaBorda
committed
update paths & codeowners
1 parent 57e0a7d commit 79eceaa

File tree

7 files changed

+61
-70
lines changed

7 files changed

+61
-70
lines changed

‎.github/CODEOWNERS‎

Lines changed: 37 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -16,48 +16,48 @@
1616
/docs/ @edenlightning @tchaton @borda @awaelchli @RobertLaurella
1717
/.github/*.md @edenlightning @williamfalcon @borda
1818
/.github/ISSUE_TEMPLATE/ @edenlightning @borda @tchaton
19-
/docs/source/conf.py @borda @awaelchli @carmocca
20-
/docs/source/index.rst @williamfalcon
21-
/docs/source/levels @williamfalcon @RobertLaurella
22-
/docs/source/expertise_levels @williamfalcon @RobertLaurella
19+
/docs/source-PL/conf.py @borda @awaelchli @carmocca
20+
/docs/source-PL/index.rst @williamfalcon
21+
/docs/source-PL/levels @williamfalcon @RobertLaurella
22+
/docs/source-PL/expertise_levels @williamfalcon @RobertLaurella
2323

2424
# Packages
25-
/pytorch_lightning/accelerators @williamfalcon @tchaton @SeanNaren @awaelchli @justusschock @kaushikb11
26-
/pytorch_lightning/callbacks @williamfalcon @tchaton @carmocca @borda @kaushikb11
27-
/pytorch_lightning/core @tchaton @SeanNaren @borda @carmocca @justusschock @kaushikb11
28-
/pytorch_lightning/distributed @williamfalcon @tchaton @awaelchli @kaushikb11
29-
/pytorch_lightning/lite @tchaton @awaelchli @carmocca
30-
/pytorch_lightning/loggers @tchaton @awaelchli @borda
31-
/pytorch_lightning/loggers/wandb.py @borisdayma
32-
/pytorch_lightning/loggers/neptune.py @shnela @HubertJaworski @pkasprzyk @pitercl @Raalsky @aniezurawski @kamil-kaczmarek
33-
/pytorch_lightning/loops @tchaton @awaelchli @justusschock @carmocca
34-
/pytorch_lightning/overrides @tchaton @SeanNaren @borda
35-
/pytorch_lightning/plugins @tchaton @SeanNaren @awaelchli @justusschock
36-
/pytorch_lightning/profiler @williamfalcon @tchaton @borda @carmocca
37-
/pytorch_lightning/profiler/pytorch.py @nbcsm @guotuofeng
38-
/pytorch_lightning/strategies @tchaton @SeanNaren @awaelchli @justusschock @kaushikb11
39-
/pytorch_lightning/trainer @williamfalcon @borda @tchaton @SeanNaren @carmocca @awaelchli @justusschock @kaushikb11
40-
/pytorch_lightning/trainer/connectors @tchaton @SeanNaren @carmocca @borda
41-
/pytorch_lightning/tuner @SkafteNicki @borda @awaelchli
42-
/pytorch_lightning/utilities @borda @tchaton @SeanNaren @carmocca
25+
/src/pytorch_lightning/accelerators @williamfalcon @tchaton @SeanNaren @awaelchli @justusschock @kaushikb11
26+
/src/pytorch_lightning/callbacks @williamfalcon @tchaton @carmocca @borda @kaushikb11
27+
/src/pytorch_lightning/core @tchaton @SeanNaren @borda @carmocca @justusschock @kaushikb11
28+
/src/pytorch_lightning/distributed @williamfalcon @tchaton @awaelchli @kaushikb11
29+
/src/pytorch_lightning/lite @tchaton @awaelchli @carmocca
30+
/src/pytorch_lightning/loggers @tchaton @awaelchli @borda
31+
/src/pytorch_lightning/loggers/wandb.py @borisdayma
32+
/src/pytorch_lightning/loggers/neptune.py @shnela @HubertJaworski @pkasprzyk @pitercl @Raalsky @aniezurawski @kamil-kaczmarek
33+
/src/pytorch_lightning/loops @tchaton @awaelchli @justusschock @carmocca
34+
/src/pytorch_lightning/overrides @tchaton @SeanNaren @borda
35+
/src/pytorch_lightning/plugins @tchaton @SeanNaren @awaelchli @justusschock
36+
/src/pytorch_lightning/profiler @williamfalcon @tchaton @borda @carmocca
37+
/src/pytorch_lightning/profiler/pytorch.py @nbcsm @guotuofeng
38+
/src/pytorch_lightning/strategies @tchaton @SeanNaren @awaelchli @justusschock @kaushikb11
39+
/src/pytorch_lightning/trainer @williamfalcon @borda @tchaton @SeanNaren @carmocca @awaelchli @justusschock @kaushikb11
40+
/src/pytorch_lightning/trainer/connectors @tchaton @SeanNaren @carmocca @borda
41+
/src/pytorch_lightning/tuner @SkafteNicki @borda @awaelchli
42+
/src/pytorch_lightning/utilities @borda @tchaton @SeanNaren @carmocca
4343

4444
# Specifics
45-
/pytorch_lightning/trainer/connectors/logger_connector @tchaton @carmocca
46-
/pytorch_lightning/trainer/progress.py @tchaton @awaelchli @carmocca
45+
/src/pytorch_lightning/trainer/connectors/logger_connector @tchaton @carmocca
46+
/src/pytorch_lightning/trainer/progress.py @tchaton @awaelchli @carmocca
4747

4848
# API
49-
/pytorch_lightning/callbacks/base.py @williamfalcon @awaelchli @ananthsub @carmocca
50-
/pytorch_lightning/core/datamodule.py @williamFalcon @awaelchli @ananthsub @carmocca
51-
/pytorch_lightning/trainer/trainer.py @williamfalcon @tchaton @awaelchli
52-
/pytorch_lightning/core/hooks.py @williamfalcon @tchaton @awaelchli @ananthsub @carmocca
53-
/pytorch_lightning/core/lightning.py @williamfalcon @tchaton @awaelchli
49+
/src/pytorch_lightning/callbacks/base.py @williamfalcon @awaelchli @ananthsub @carmocca
50+
/src/pytorch_lightning/core/datamodule.py @williamFalcon @awaelchli @ananthsub @carmocca
51+
/src/pytorch_lightning/trainer/trainer.py @williamfalcon @tchaton @awaelchli
52+
/src/pytorch_lightning/core/hooks.py @williamfalcon @tchaton @awaelchli @ananthsub @carmocca
53+
/src/pytorch_lightning/core/lightning.py @williamfalcon @tchaton @awaelchli
5454

5555
# Testing
56-
/tests/helpers/boring_model.py @williamfalcon @tchaton @borda
57-
58-
/.github/CODEOWNERS @williamfalcon
59-
/.github/approve_config.yml @williamfalcon
60-
/SECURITY.md @williamfalcon
61-
/README.md @williamfalcon @edenlightning @borda
62-
/setup.py @williamfalcon @borda @carmocca
63-
/pytorch_lightning/__about__.py @williamfalcon @borda @carmocca
56+
/test/unittests_pl/helpers/boring_model.py @williamfalcon @tchaton @borda
57+
58+
/.github/CODEOWNERS @williamfalcon
59+
/.github/approve_config.yml @williamfalcon
60+
/SECURITY.md @williamfalcon
61+
/README.md @williamfalcon @edenlightning @borda
62+
/setup.py @williamfalcon @borda @carmocca
63+
/src/pytorch_lightning/__about__.py @williamfalcon @borda @carmocca

‎.github/CONTRIBUTING.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ To learn about development of docs, check out the docs [README.md](https://githu
134134

135135
### Testing
136136

137-
To learn about tests, check out the tests [README.md](https://github.com/PyTorchLightning/pytorch-lightning/blob/master/tests/README.md).
137+
To learn about tests, check out the tests [README.md](https://github.com/PyTorchLightning/pytorch-lightning/blob/master/test/README.md).
138138

139139
### Pull Request
140140

@@ -165,7 +165,7 @@ We welcome any useful contribution! For your convenience here's a recommended wo
165165

166166
1. If any of the existing tests fail in your PR on our CI, refer to the following READMEs to identify what's failing and try to address it.
167167

168-
- [Test README](https://github.com/PyTorchLightning/pytorch-lightning/blob/master/tests/README.md)
168+
- [Test README](https://github.com/PyTorchLightning/pytorch-lightning/blob/master/test/README.md)
169169
- [CI/CD README](https://github.com/PyTorchLightning/pytorch-lightning/blob/master/.github/workflows/README.md)
170170

171171
1. When you feel ready for integrating your work, mark your PR "Ready for review".
@@ -235,7 +235,7 @@ Here are tutorials:
235235
Here is the process to create a new test
236236

237237
- 0. Optional: Follow tutorials !
238-
- 1. Find a file in tests/ which match what you want to test. If none, create one.
238+
- 1. Find a file in test/ which match what you want to test. If none, create one.
239239
- 2. Use this template to get started !
240240
- 3. Use **BoringModel and derivates to test out your code**.
241241

‎.gitignore‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -71,9 +71,8 @@ nosetests.xml
7171
coverage.xml
7272
*.cover
7373
.hypothesis/
74-
tests/tests_tt_dir/
75-
tests/save_dir
76-
tests/tests/
74+
test/*/tests_tt_dir/
75+
test/*/save_dir
7776

7877
# Translations
7978
*.mo

‎MANIFEST.in‎

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,3 @@
1-
# Copyright The PyTorch Lightning team.
2-
#
3-
# Licensed under the Apache License, Version 2.0 (the "License");
4-
# you may not use this file except in compliance with the License.
5-
# You may obtain a copy of the License at
6-
#
7-
# http://www.apache.org/licenses/LICENSE-2.0
8-
#
9-
# Unless required by applicable law or agreed to in writing, software
10-
# distributed under the License is distributed on an "AS IS" BASIS,
11-
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12-
# See the License for the specific language governing permissions and
13-
# limitations under the License.
141
include pytorch_lightning/py.typed # marker file for PEP 561
152
include CHANGELOG.md
163
recursive-include requirements *.txt

‎Makefile‎

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,18 +14,23 @@ clean:
1414
rm -rf .mypy_cache
1515
rm -rf .pytest_cache
1616
rm -rf ./docs/build
17-
rm -rf ./docs/source/notebooks
18-
rm -rf ./docs/source/generated
19-
rm -rf ./docs/source/*/generated
20-
rm -rf ./docs/source/api
17+
rm -rf ./docs/source-PL/notebooks
18+
rm -rf ./docs/source-PL/generated
19+
rm -rf ./docs/source-PL/*/generated
20+
rm -rf ./docs/source-PL/api
21+
rm -rf build
22+
rm -rf dist
23+
rm -rf *.egg-info
24+
rm -rf src/*.egg-info
2125

2226
test: clean
2327
# Review the CONTRIBUTING documentation for other ways to test.
24-
pip install -r requirements/devel.txt
28+
pip install -e . -r requirements/devel.txt
2529
pip install -r requirements/strategies.txt
2630
# run tests with coverage
27-
python -m coverage run --source pytorch_lightning -m pytest pytorch_lightning tests -v
28-
python -m coverage report
31+
cd src && python -m pytest pytorch_lightning
32+
cd test && python -m coverage run --source pytorch_lightning -m pytest unittests_pl -v
33+
cd test && python -m coverage report
2934

3035
docs: clean
3136
pip install -e . --quiet -r requirements/docs.txt

‎setup.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -72,13 +72,13 @@ def _load_readme_description(path_dir: str, homepage: str, version: str) -> str:
7272
text = open(path_readme, encoding="utf-8").read()
7373

7474
# drop images from readme
75-
text = text.replace("![PT to PL](docs/source/_static/images/general/pl_quick_start_full_compressed.gif)", "")
75+
text = text.replace("![PT to PL](docs/source-PL/_static/images/general/pl_quick_start_full_compressed.gif)", "")
7676

77-
# https://github.com/PyTorchLightning/pytorch-lightning/raw/master/docs/source/_static/images/lightning_module/pt_to_pl.png
77+
# https://github.com/PyTorchLightning/pytorch-lightning/raw/master/docs/source-PL/_static/images/lightning_module/pt_to_pl.png
7878
github_source_url = os.path.join(homepage, "raw", version)
7979
# replace relative repository path to absolute link to the release
8080
# do not replace all "docs" as in the readme we reger some other sources with particular path to docs
81-
text = text.replace("docs/source/_static/", f"{os.path.join(github_source_url, 'docs/source-PL/_static/')}")
81+
text = text.replace("docs/source-PL/_static/", f"{os.path.join(github_source_url, 'docs/source-PL/_static/')}")
8282

8383
# readthedocs badge
8484
text = text.replace("badge/?version=stable", f"badge/?version={version}")

‎test/README.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# PyTorch-Lightning Tests
22

3-
Most of the tests in PyTorch Lightning train a [BoringModel](https://github.com/PyTorchLightning/pytorch-lightning/blob/master/tests/helpers/boring_model.py) under various trainer conditions (ddp, ddp2+amp, etc...). Want to add a new test case and not sure how? [Talk to us!](https://www.pytorchlightning.ai/community)
3+
Most of the tests in PyTorch Lightning train a [BoringModel](https://github.com/PyTorchLightning/pytorch-lightning/blob/master/test/unittests_pl/helpers/boring_model.py) under various trainer conditions (ddp, ddp2+amp, etc...). Want to add a new test case and not sure how? [Talk to us!](https://www.pytorchlightning.ai/community)
44

55
## Running tests
66

@@ -47,7 +47,7 @@ python -m pytest src/pytorch_lightning test/unitests_pl -v
4747
You can also run a single test as follows:
4848

4949
```bash
50-
python -m pytest -v tests/trainer/test_trainer_cli.py::test_default_args
50+
python -m pytest -v test/unittests_pl/trainer/test_trainer_cli.py::test_default_args
5151
```
5252

5353
### Conditional Tests
@@ -64,9 +64,9 @@ You can rely on our CI to make sure all these tests pass.
6464
There are certain standalone tests, which you can run using:
6565

6666
```bash
67-
PL_RUN_STANDALONE_TESTS=1 python -m pytest -v tests/trainer/
67+
PL_RUN_STANDALONE_TESTS=1 python -m pytest -v test/unittests_pl/trainer/
6868
# or
69-
./tests/standalone_tests.sh tests/trainer
69+
./test/standalone_tests.sh test/unittests_pl/trainer
7070
```
7171

7272
## Running Coverage

0 commit comments

Comments
 (0)