From c4b0693a4d5ddcb67bb2befaad5411bf674c8fc6 Mon Sep 17 00:00:00 2001 From: William Falcon Date: Wed, 19 Feb 2020 06:26:23 -0500 Subject: [PATCH] update governance docs (#894) * updated governance docs * added maintainers to readme * added governance docs --- CHANGELOG.md | 1 + README.md | 16 +++++++++++++++- docs/source/governance.rst | 10 +++++++--- 3 files changed, 23 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index cfc5e2d8..9a5fdaa8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/). ## [Unreleased] ### Added +- Updated governance docs - Added a check to ensure that the metric used for early stopping exists before training commences ([#542](https://github.com/PyTorchLightning/pytorch-lightning/pull/542)) - Added `optimizer_idx` argument to `backward` hook ([#733](https://github.com/PyTorchLightning/pytorch-lightning/pull/733)) - Added `entity` argument to `WandbLogger` to be passed to `wandb.init` ([#783](https://github.com/PyTorchLightning/pytorch-lightning/pull/783)) diff --git a/README.md b/README.md index 98f57bbc..ecd2fe1e 100644 --- a/README.md +++ b/README.md @@ -87,10 +87,11 @@ Lightning sets up all the boilerplate state-of-the-art training for you so you c - [Lightning features](https://github.com/PytorchLightning/pytorch-lightning#lightning-automates-all-of-the-following-each-is-also-configurable) - [Examples](https://github.com/PytorchLightning/pytorch-lightning#examples) - [Tutorials](https://github.com/PytorchLightning/pytorch-lightning#tutorials) +- [Asking for help](https://github.com/PytorchLightning/pytorch-lightning#asking-for-help) - [Contributing](https://github.com/PytorchLightning/pytorch-lightning/blob/master/.github/CONTRIBUTING.md) - [Bleeding edge install](https://github.com/PytorchLightning/pytorch-lightning#bleeding-edge) - [Lightning Design Principles](https://github.com/PytorchLightning/pytorch-lightning#lightning-design-principles) -- [Asking for help](https://github.com/PytorchLightning/pytorch-lightning#asking-for-help) +- [Lightning team](https://github.com/PytorchLightning/pytorch-lightning#lightning-team) - [FAQ](https://github.com/PytorchLightning/pytorch-lightning#faq) --- @@ -387,6 +388,19 @@ You can also install any past release `0.X.Y` from this repository: pip install https://github.com/PytorchLightning/pytorch-lightning/archive/0.X.Y.zip --upgrade ``` +### Lightning team + +#### Leads +- William Falcon [(williamFalcon)](https://github.com/williamFalcon) (Lightning founder) +- Jirka Borovek [(Borda)](https://github.com/Borda) +- Ethan Harris [(ethanwharris)](https://github.com/ethanwharris) (Torchbearer founder) + +#### Core Maintainers + +- Nick Eggert [(neggert)](https://github.com/neggert) +- Jeff Ling [(jeffling)](https://github.com/jeffling) +- Tullie Murrell [(tullie)](https://github.com/tullie) + ## Bibtex If you want to cite the framework feel free to use this (but only if you loved it 😊): ``` diff --git a/docs/source/governance.rst b/docs/source/governance.rst index 3dfcaf70..bf3033c3 100644 --- a/docs/source/governance.rst +++ b/docs/source/governance.rst @@ -1,10 +1,14 @@ Pytorch Lightning Governance | Persons of interest ================================================== -Maintainers ------------ -- William Falcon (`williamFalcon `_) +Leads +----- +- William Falcon (`williamFalcon `_) (Lightning founder) - Jirka Borovek (`Borda `_) +- Ethan Harris `ethanwharris `_ (Torchbearer founder) + +Core Maintainers +---------------- - Nick Eggert (`neggert `_) - Jeff Ling (`jeffling `_) - Tullie Murrell (`tullie `_)