Rooba
/
lightning
mirror of https://github.com/Lightning-AI/lightning.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Added missing docs on[ TrainResult and EvalResult source docs. (#3157) 

* Added missing parameter 'minimize' docs in TrainResult

* Added missing docs for parameters in TrainResult and EvalResult
This commit is contained in:
Vicente Oyanedel Muñoz 2020-08-25 11:04:37 -04:00 committed by GitHub
parent 50aed42d6b
commit 5f39ae804a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
pytorch_lightning/core/step_result.py
View File

@ -497,8 +497,9 @@ class TrainResult(Result):
return result
Args:
early_stop_on:
checkpoint_on:
minimize: Metric currently being minimized.
early_stop_on: Metric to early stop on.
checkpoint_on: Metric to checkpoint on.
hiddens:
"""
@ -652,8 +653,8 @@ class EvalResult(Result):
return result
Args:
early_stop_on:
checkpoint_on:
early_stop_on: Metric to early stop on.
checkpoint_on: Metric to checkpoint on.
hiddens:
"""