Skip to content

Commit

Permalink
update paths & codeowners
Browse files Browse the repository at this point in the history
  • Loading branch information
@Borda
Borda committed Jun 10, 2022
1 parent 57e0a7d commit 79eceaa
Show file tree
Hide file tree
Showing 7 changed files with 61 additions and 70 deletions.
74 changes: 37 additions & 37 deletions .github/CODEOWNERS
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,48 +16,48 @@
/docs/ @edenlightning @tchaton @borda @awaelchli @RobertLaurella
/.github/*.md @edenlightning @williamfalcon @borda
/.github/ISSUE_TEMPLATE/ @edenlightning @borda @tchaton
/docs/source/conf.py @borda @awaelchli @carmocca
/docs/source/index.rst @williamfalcon
/docs/source/levels @williamfalcon @RobertLaurella
/docs/source/expertise_levels @williamfalcon @RobertLaurella
/docs/source-PL/conf.py @borda @awaelchli @carmocca
/docs/source-PL/index.rst @williamfalcon
/docs/source-PL/levels @williamfalcon @RobertLaurella
/docs/source-PL/expertise_levels @williamfalcon @RobertLaurella

# Packages
/pytorch_lightning/accelerators @williamfalcon @tchaton @SeanNaren @awaelchli @justusschock @kaushikb11
/pytorch_lightning/callbacks @williamfalcon @tchaton @carmocca @borda @kaushikb11
/pytorch_lightning/core @tchaton @SeanNaren @borda @carmocca @justusschock @kaushikb11
/pytorch_lightning/distributed @williamfalcon @tchaton @awaelchli @kaushikb11
/pytorch_lightning/lite @tchaton @awaelchli @carmocca
/pytorch_lightning/loggers @tchaton @awaelchli @borda
/pytorch_lightning/loggers/wandb.py @borisdayma
/pytorch_lightning/loggers/neptune.py @shnela @HubertJaworski @pkasprzyk @pitercl @Raalsky @aniezurawski @kamil-kaczmarek
/pytorch_lightning/loops @tchaton @awaelchli @justusschock @carmocca
/pytorch_lightning/overrides @tchaton @SeanNaren @borda
/pytorch_lightning/plugins @tchaton @SeanNaren @awaelchli @justusschock
/pytorch_lightning/profiler @williamfalcon @tchaton @borda @carmocca
/pytorch_lightning/profiler/pytorch.py @nbcsm @guotuofeng
/pytorch_lightning/strategies @tchaton @SeanNaren @awaelchli @justusschock @kaushikb11
/pytorch_lightning/trainer @williamfalcon @borda @tchaton @SeanNaren @carmocca @awaelchli @justusschock @kaushikb11
/pytorch_lightning/trainer/connectors @tchaton @SeanNaren @carmocca @borda
/pytorch_lightning/tuner @SkafteNicki @borda @awaelchli
/pytorch_lightning/utilities @borda @tchaton @SeanNaren @carmocca
/src/pytorch_lightning/accelerators @williamfalcon @tchaton @SeanNaren @awaelchli @justusschock @kaushikb11
/src/pytorch_lightning/callbacks @williamfalcon @tchaton @carmocca @borda @kaushikb11
/src/pytorch_lightning/core @tchaton @SeanNaren @borda @carmocca @justusschock @kaushikb11
/src/pytorch_lightning/distributed @williamfalcon @tchaton @awaelchli @kaushikb11
/src/pytorch_lightning/lite @tchaton @awaelchli @carmocca
/src/pytorch_lightning/loggers @tchaton @awaelchli @borda
/src/pytorch_lightning/loggers/wandb.py @borisdayma
/src/pytorch_lightning/loggers/neptune.py @shnela @HubertJaworski @pkasprzyk @pitercl @Raalsky @aniezurawski @kamil-kaczmarek
/src/pytorch_lightning/loops @tchaton @awaelchli @justusschock @carmocca
/src/pytorch_lightning/overrides @tchaton @SeanNaren @borda
/src/pytorch_lightning/plugins @tchaton @SeanNaren @awaelchli @justusschock
/src/pytorch_lightning/profiler @williamfalcon @tchaton @borda @carmocca
/src/pytorch_lightning/profiler/pytorch.py @nbcsm @guotuofeng
/src/pytorch_lightning/strategies @tchaton @SeanNaren @awaelchli @justusschock @kaushikb11
/src/pytorch_lightning/trainer @williamfalcon @borda @tchaton @SeanNaren @carmocca @awaelchli @justusschock @kaushikb11
/src/pytorch_lightning/trainer/connectors @tchaton @SeanNaren @carmocca @borda
/src/pytorch_lightning/tuner @SkafteNicki @borda @awaelchli
/src/pytorch_lightning/utilities @borda @tchaton @SeanNaren @carmocca

# Specifics
/pytorch_lightning/trainer/connectors/logger_connector @tchaton @carmocca
/pytorch_lightning/trainer/progress.py @tchaton @awaelchli @carmocca
/src/pytorch_lightning/trainer/connectors/logger_connector @tchaton @carmocca
/src/pytorch_lightning/trainer/progress.py @tchaton @awaelchli @carmocca

# API
/pytorch_lightning/callbacks/base.py @williamfalcon @awaelchli @ananthsub @carmocca
/pytorch_lightning/core/datamodule.py @williamFalcon @awaelchli @ananthsub @carmocca
/pytorch_lightning/trainer/trainer.py @williamfalcon @tchaton @awaelchli
/pytorch_lightning/core/hooks.py @williamfalcon @tchaton @awaelchli @ananthsub @carmocca
/pytorch_lightning/core/lightning.py @williamfalcon @tchaton @awaelchli
/src/pytorch_lightning/callbacks/base.py @williamfalcon @awaelchli @ananthsub @carmocca
/src/pytorch_lightning/core/datamodule.py @williamFalcon @awaelchli @ananthsub @carmocca
/src/pytorch_lightning/trainer/trainer.py @williamfalcon @tchaton @awaelchli
/src/pytorch_lightning/core/hooks.py @williamfalcon @tchaton @awaelchli @ananthsub @carmocca
/src/pytorch_lightning/core/lightning.py @williamfalcon @tchaton @awaelchli

# Testing
/tests/helpers/boring_model.py @williamfalcon @tchaton @borda

/.github/CODEOWNERS @williamfalcon
/.github/approve_config.yml @williamfalcon
/SECURITY.md @williamfalcon
/README.md @williamfalcon @edenlightning @borda
/setup.py @williamfalcon @borda @carmocca
/pytorch_lightning/__about__.py @williamfalcon @borda @carmocca
/test/unittests_pl/helpers/boring_model.py @williamfalcon @tchaton @borda

/.github/CODEOWNERS @williamfalcon
/.github/approve_config.yml @williamfalcon
/SECURITY.md @williamfalcon
/README.md @williamfalcon @edenlightning @borda
/setup.py @williamfalcon @borda @carmocca
/src/pytorch_lightning/__about__.py @williamfalcon @borda @carmocca
6 changes: 3 additions & 3 deletions .github/CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ To learn about development of docs, check out the docs [README.md](https://githu

### Testing

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

### Pull Request

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

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.

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

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

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

Expand Down
5 changes: 2 additions & 3 deletions .gitignore
View file
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,8 @@ nosetests.xml
coverage.xml
*.cover
.hypothesis/
tests/tests_tt_dir/
tests/save_dir
tests/tests/
test/*/tests_tt_dir/
test/*/save_dir

# Translations
*.mo
Expand Down
13 changes: 0 additions & 13 deletions MANIFEST.in
View file
Original file line number Diff line number Diff line change
@@ -1,16 +1,3 @@
# Copyright The PyTorch Lightning team.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
include pytorch_lightning/py.typed # marker file for PEP 561
include CHANGELOG.md
recursive-include requirements *.txt
Expand Down
19 changes: 12 additions & 7 deletions Makefile
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,18 +14,23 @@ clean:
rm -rf .mypy_cache
rm -rf .pytest_cache
rm -rf ./docs/build
rm -rf ./docs/source/notebooks
rm -rf ./docs/source/generated
rm -rf ./docs/source/*/generated
rm -rf ./docs/source/api
rm -rf ./docs/source-PL/notebooks
rm -rf ./docs/source-PL/generated
rm -rf ./docs/source-PL/*/generated
rm -rf ./docs/source-PL/api
rm -rf build
rm -rf dist
rm -rf *.egg-info
rm -rf src/*.egg-info

test: clean
# Review the CONTRIBUTING documentation for other ways to test.
pip install -r requirements/devel.txt
pip install -e . -r requirements/devel.txt
pip install -r requirements/strategies.txt
# run tests with coverage
python -m coverage run --source pytorch_lightning -m pytest pytorch_lightning tests -v
python -m coverage report
cd src && python -m pytest pytorch_lightning
cd test && python -m coverage run --source pytorch_lightning -m pytest unittests_pl -v
cd test && python -m coverage report

docs: clean
pip install -e . --quiet -r requirements/docs.txt
Expand Down
6 changes: 3 additions & 3 deletions setup.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -72,13 +72,13 @@ def _load_readme_description(path_dir: str, homepage: str, version: str) -> str:
text = open(path_readme, encoding="utf-8").read()

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

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

# readthedocs badge
text = text.replace("badge/?version=stable", f"badge/?version={version}")
Expand Down
8 changes: 4 additions & 4 deletions test/README.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# PyTorch-Lightning Tests

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)
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)

## Running tests

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

```bash
python -m pytest -v tests/trainer/test_trainer_cli.py::test_default_args
python -m pytest -v test/unittests_pl/trainer/test_trainer_cli.py::test_default_args
```

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

```bash
PL_RUN_STANDALONE_TESTS=1 python -m pytest -v tests/trainer/
PL_RUN_STANDALONE_TESTS=1 python -m pytest -v test/unittests_pl/trainer/
# or
./tests/standalone_tests.sh tests/trainer
./test/standalone_tests.sh test/unittests_pl/trainer
```

## Running Coverage
Expand Down

0 comments on commit 79eceaa

Please sign in to comment.