code guideline (#1949)
* code rule * Apply suggestions from code review Co-authored-by: Jeremy Jordan <13970565+jeremyjordan@users.noreply.github.com> * chlog Co-authored-by: Jeremy Jordan <13970565+jeremyjordan@users.noreply.github.com> Co-authored-by: Nicki Skafte <skaftenicki@gmail.com>
This commit is contained in:
parent
c3cf33d1de
commit
8ee6d91d0e
|
@ -67,6 +67,12 @@ A lot of good work has already been done in project mechanics (requirements.txt,
|
|||
|
||||
## Guidelines
|
||||
|
||||
### Original code
|
||||
|
||||
All added or edited code shall be the own original work of the particular contributor.
|
||||
If you use come third-party implementation, all such blocks/functions/modules shall be properly referred and if possible also agreed by code's author. For example - `This code is inpired from http://...`.
|
||||
In case you adding new dependencies, make sure that they are compatible the actual PyTorch Lightning license (ie. dependencies should be _at least_ as permissive as the PyTorch Lightning license).
|
||||
|
||||
### Coding Style
|
||||
|
||||
1. Use f-strings for output formation (except logging when we stay with lazy `logging.info("Hello %s!`, name).
|
||||
|
|
|
@ -44,8 +44,9 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
|
|||
|
||||
- Fixed bug related to logger not being reset correctly for model after tuner algorithms ([#1933](https://github.com/PyTorchLightning/pytorch-lightning/pull/1933))
|
||||
|
||||
- Fixed `LearningRateLogger` in multi-scheduler setting ([#1944](https://github.com/PyTorchLightning/pytorch-lightning/pull/1944))
|
||||
- Fixed root node resolution for SLURM cluster with dash in host name ([#1954](https://github.com/PyTorchLightning/pytorch-lightning/pull/1954))
|
||||
|
||||
- Fixed `LearningRateLogger` in multi-scheduler setting ([#1944](https://github.com/PyTorchLightning/pytorch-lightning/pull/1944))
|
||||
|
||||
## [0.7.6] - 2020-05-16
|
||||
|
||||
|
|
|
@ -65,6 +65,11 @@ version = pytorch_lightning.__version__
|
|||
# The full version, including alpha/beta/rc tags
|
||||
release = pytorch_lightning.__version__
|
||||
|
||||
# Options for the linkcode extension
|
||||
# ----------------------------------
|
||||
github_user = 'PyTorchLightning'
|
||||
github_repo = project
|
||||
|
||||
# -- General configuration ---------------------------------------------------
|
||||
|
||||
# If your documentation needs a minimal Sphinx version, state it here.
|
||||
|
@ -338,12 +343,6 @@ MOCK_MANUAL_PACKAGES = [
|
|||
autodoc_mock_imports = MOCK_PACKAGES + MOCK_MANUAL_PACKAGES
|
||||
|
||||
|
||||
# Options for the linkcode extension
|
||||
# ----------------------------------
|
||||
github_user = 'PyTorchLightning'
|
||||
github_repo = project
|
||||
|
||||
|
||||
# Resolve function
|
||||
# This function is used to populate the (source) links in the API
|
||||
def linkcode_resolve(domain, info):
|
||||
|
|
Loading…
Reference in New Issue